gl2d.h File Reference

A very small and simple DS rendering lib using the 3d core to render 2D stuff. More...

#include <nds/arm9/videoGL.h>

Data Structures
struct	glImage
	Struct for our GL-Based Images. More...

Enumerations
enum	GL_FLIP_MODE {   GL_FLIP_NONE = (1 << 0) ,   GL_FLIP_V = (1 << 1) ,   GL_FLIP_H = (1 << 2) }
	Enums selecting flipping mode. More...

Functions
void	glBegin2D (void)
	Sets up OpenGL for 2d rendering.
void	glBox (int x1, int y1, int x2, int y2, int color)
	Draws a box.
void	glBoxFilled (int x1, int y1, int x2, int y2, int color)
	Draws a filled box.
void	glBoxFilledGradient (int x1, int y1, int x2, int y2, int color1, int color2, int color3, int color4)
	Draws a filled box in gradient colors.
void	glEnd2D (void)
	Issue this after drawing 2d so that we don't mess the matrix stack.
static int	glGetActiveTexture (void)
	Returns the active texture. Use with care.
void	glLine (int x1, int y1, int x2, int y2, int color)
	Draws a line.
int	glLoadSpriteSet (glImage *sprite, const unsigned int numframes, const uint16_t *texcoords, GL_TEXTURE_TYPE_ENUM type, int sizeX, int sizeY, int param, int palette_width, const void *palette, const void *texture)
	Initializes our spriteset with Texture Packer generated UV coordinates.
int	glLoadTileSet (glImage *sprite, int tile_wid, int tile_hei, int bmp_wid, int bmp_hei, GL_TEXTURE_TYPE_ENUM type, int sizeX, int sizeY, int param, int palette_width, const void *palette, const void *texture)
	Initializes our tileset (like glInitSpriteset()) but without the use of Texture Packer auto-generated files.
void	glPutPixel (int x, int y, int color)
	Draws a pixel.
void	glScreen2D (void)
	Initializes GL in 2D mode.
static void	glSetActiveTexture (int TextureID)
	Set the active texture. Use with care.
void	glSprite (int x, int y, int flipmode, const glImage *spr)
	Draws a sprite.
void	glSpriteOnQuad (int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4, int uoff, int voff, int flipmode, const glImage *spr)
	Draws a horizontaly stretched sprite (clean stretching).
void	glSpriteRotate (int x, int y, s32 angle, int flipmode, const glImage *spr)
	Draws a center rotated sprite.
void	glSpriteRotateScale (int x, int y, s32 angle, s32 scale, int flipmode, const glImage *spr)
	Draws a center rotated scaled sprite.
void	glSpriteRotateScaleXY (int x, int y, s32 angle, s32 scaleX, s32 scaleY, int flipmode, const glImage *spr)
	Draws a center rotated axis-exclusive scaled sprite.
void	glSpriteScale (int x, int y, s32 scale, int flipmode, const glImage *spr)
	Draws a scaled sprite.
void	glSpriteScaleXY (int x, int y, s32 scaleX, s32 scaleY, int flipmode, const glImage *spr)
	Draws an axis exclusive scaled sprite.
void	glSpriteStretchHorizontal (int x, int y, int length_x, const glImage *spr)
	Draws a horizontaly stretched sprite (clean stretching).
void	glTriangle (int x1, int y1, int x2, int y2, int x3, int y3, int color)
	Draws a triangle.
void	glTriangleFilled (int x1, int y1, int x2, int y2, int x3, int y3, int color)
	Draws a filled triangle.
void	glTriangleFilledGradient (int x1, int y1, int x2, int y2, int x3, int y3, int color1, int color2, int color3)
	Draws a triangle in gradient colors.

Detailed Description

A very small and simple DS rendering lib using the 3d core to render 2D stuff.

API

• Reference

Enumeration Type Documentation

GL_FLIP_MODE

enum GL_FLIP_MODE

Enums selecting flipping mode.

These enums are bits for flipping the sprites.

You can or GL_FLIP_V and GL_FLIP_H to flip both ways: GL_FLIP_V | GL_FLIP_H

• Related functions:
  1. glSprite()
  2. glSpriteScale()
  3. glSpriteRotate()
  4. glSpriteScaleXY()
  5. glSpriteRotateScale()
  6. glSpriteRotateScaleXY()
  7. glSpriteOnQuad()

Enumerator
GL_FLIP_NONE	No flipping.
GL_FLIP_V	Sprite is rendered vertically flipped.
GL_FLIP_H	Sprite is rendered horizontally flipped.

Function Documentation

glBegin2D()

void glBegin2D

(

void

)

Sets up OpenGL for 2d rendering.

Call this before drawing any of GL2D's drawing or sprite functions.

glBox()

void glBox	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	color
	)

Draws a box.

Parameters

x1,y1	Top-Left coordinate of the box.
x2,y2	Bottom-Right coordinate of the box.
color	RGB15/ARGB16 color.

glBoxFilled()

void glBoxFilled	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	color
	)

Draws a filled box.

Parameters

x1,y1	Top-Left coordinate of the box.
x2,y2	Bottom-Right coordinate of the box.
color	RGB15/ARGB16 color.

glBoxFilledGradient()

void glBoxFilledGradient	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	color1,
		int	color2,
		int	color3,
		int	color4
	)

Draws a filled box in gradient colors.

Parameters

x1,y1	Top-Left coordinate of the box.
x2,y2	Bottom-Right coordinate of the box.
color1	RGB15/ARGB16 color of the Top-Left corner.
color2	RGB15/ARGB16 color of the Bottom-Left corner.
color3	RGB15/ARGB16 color of the Bottom-Right corner.
color4	RGB15/ARGB16 color of the Top-Right corner.

glEnd2D()

void glEnd2D

(

void

)

Issue this after drawing 2d so that we don't mess the matrix stack.

The compliment of glBegin2D().

glGetActiveTexture()

static int glGetActiveTexture ( void  )

inlinestatic

Returns the active texture. Use with care.

Needed to achieve some effects since libnds 1.5.0.

Returns

Returns the texture ID.

glLine()

void glLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	color
	)

Draws a line.

Parameters

x1,y1	Top-Left coordinate of the line.
x2,y2	Bottom-Right coordinate of the line.
color	RGB15/ARGB16 color.

glLoadSpriteSet()

int glLoadSpriteSet	(	glImage *	sprite,
		const unsigned int	numframes,
		const uint16_t *	texcoords,
		GL_TEXTURE_TYPE_ENUM	type,
		int	sizeX,
		int	sizeY,
		int	param,
		int	palette_width,
		const void *	palette,
		const void *	texture
	)

Initializes our spriteset with Texture Packer generated UV coordinates.

Very safe and easy to use.

Parameters

sprite	Pointer to an array of glImage.
numframes	Number of frames in a spriteset (auto-generated by Texture Packer).
texcoords	Texture Packer auto-generated array of UV coords.
type	The format of the texture (see glTexImage2D()).
sizeX	The horizontal size of the texture; valid sizes are enumerated in GL_TEXTURE_TYPE_ENUM (see glTexImage2D()).
sizeY	The vertical size of the texture; valid sizes are enumerated in GL_TEXTURE_TYPE_ENUM (see glTexImage2D()).
param	Parameters for the texture (see glTexImage2D()).
palette_width	Length of the palette. Valid values are 4, 16, 32, 256 (if 0, the palette is removed from the currently bound texture).
palette	Pointer to the palette data to load (if NULL, then palette is emoved from currently bound texture).
texture	Pointer to the texture data to load.

Returns

Returns the texture ID on success, -1 on error.

glLoadTileSet()

int glLoadTileSet	(	glImage *	sprite,
		int	tile_wid,
		int	tile_hei,
		int	bmp_wid,
		int	bmp_hei,
		GL_TEXTURE_TYPE_ENUM	type,
		int	sizeX,
		int	sizeY,
		int	param,
		int	palette_width,
		const void *	palette,
		const void *	texture
	)

Initializes our tileset (like glInitSpriteset()) but without the use of Texture Packer auto-generated files.

Can only be used when tiles in a tilset are of the same dimensions.

Parameters

sprite	Pointer to an array of glImage.
tile_wid	Width of each tile in the texture.
tile_hei	Height of each tile in the texture.
bmp_wid	Width of of the texture or tileset.
bmp_hei	height of of the texture or tileset.
type	The format of the texture (see glTexImage2D()).
sizeX	The horizontal size of the texture; valid sizes are enumerated in GL_TEXTURE_TYPE_ENUM (see glTexImage2D()).
sizeY	The vertical size of the texture; valid sizes are enumerated in GL_TEXTURE_TYPE_ENUM (see glTexImage2D()).
param	Parameters for the texture (see glTexImage2D()).
palette_width	Length of the palette. Valid values are 4, 16, 32, 256 (if 0, the palette is removed from the currently bound texture).
palette	Pointer to the palette data to load (if NULL, then palette is removed from currently bound texture).
texture	Pointer to the texture data to load.

Returns

Returns the texture ID on success, -1 on error.

glPutPixel()

void glPutPixel	(	int	x,
		int	y,
		int	color
	)

Draws a pixel.

Parameters

x	X position of the pixel.
y	Y position of the pixel.
color	RGB15/ARGB16 color.

glScreen2D()

void glScreen2D

(

void

)

Initializes GL in 2D mode.

Also initializes GL in 3d mode so that we could combine 2D and 3D later. Almost a direct copy from the DS example files.

glSetActiveTexture()

static void glSetActiveTexture ( int  TextureID )

inlinestatic

Set the active texture. Use with care.

Needed to achieve some effects since libnds 1.5.0.

Parameters

TextureID

Texture to set as active.

glSprite()

void glSprite	(	int	x,
		int	y,
		int	flipmode,
		const glImage *	spr
	)

Draws a sprite.

Parameters

x	X position of the sprite.
y	Y position of the sprite.
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteOnQuad()

void glSpriteOnQuad	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	x3,
		int	y3,
		int	x4,
		int	y4,
		int	uoff,
		int	voff,
		int	flipmode,
		const glImage *	spr
	)

Draws a horizontaly stretched sprite (clean stretching).

Useful for "shrearing effects".

Parameters

x1,y1	First corner of the sprite.
x2,y2	Second corner of the sprite.
x3,y3	Third corner of the sprite.
x4,y4	Fourth corner of the sprite.
uoff,voff	Texture offsets.
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteRotate()

void glSpriteRotate	(	int	x,
		int	y,
		s32	angle,
		int	flipmode,
		const glImage *	spr
	)

Draws a center rotated sprite.

Parameters

x	X position of the sprite center.
y	Y position of the sprite center.
angle	Binary Radian Angle(-32768 to 32767) to rotate the sprite.
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteRotateScale()

void glSpriteRotateScale	(	int	x,
		int	y,
		s32	angle,
		s32	scale,
		int	flipmode,
		const glImage *	spr
	)

Draws a center rotated scaled sprite.

Parameters

x	X position of the sprite center.
y	Y position of the sprite center.
angle	Binary Radian Angle(-32768 to 32767) to rotate the sprite.
scale	20.12 fixed-point scale value (1 << 12 is normal).
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteRotateScaleXY()

void glSpriteRotateScaleXY	(	int	x,
		int	y,
		s32	angle,
		s32	scaleX,
		s32	scaleY,
		int	flipmode,
		const glImage *	spr
	)

Draws a center rotated axis-exclusive scaled sprite.

Parameters

x	X position of the sprite center.
y	Y position of the sprite center.
angle	Binary Radian Angle(-32768 to 32767) to rotate the sprite.
scaleX	20.12 fixed-point X-Axis scale value (1 << 12 is normal).
scaleY	20.12 fixed-point Y-Axis scale value (1 << 12 is normal).
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteScale()

void glSpriteScale	(	int	x,
		int	y,
		s32	scale,
		int	flipmode,
		const glImage *	spr
	)

Draws a scaled sprite.

Parameters

x	X position of the sprite.
y	Y position of the sprite.
scale	20.12 fixed-point scale value (1 << 12 is normal).
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteScaleXY()

void glSpriteScaleXY	(	int	x,
		int	y,
		s32	scaleX,
		s32	scaleY,
		int	flipmode,
		const glImage *	spr
	)

Draws an axis exclusive scaled sprite.

Parameters

x	X position of the sprite.
y	Y position of the sprite.
scaleX	20.12 fixed-point X-Axis scale value (1 << 12 is normal).
scaleY	20.12 fixed-point Y-Axis scale value (1 << 12 is normal).
flipmode	Mode for flipping (see GL_FLIP_MODE enum).
spr	Pointer to a glImage.

glSpriteStretchHorizontal()

void glSpriteStretchHorizontal	(	int	x,
		int	y,
		int	length_x,
		const glImage *	spr
	)

Draws a horizontaly stretched sprite (clean stretching).

Useful for "laser effects".

Parameters

x	X position of the sprite center.
y	Y position of the sprite center.
length_x	The length(in pixels) to stretch the sprite.
spr	Pointer to a glImage.

glTriangle()

void glTriangle	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	x3,
		int	y3,
		int	color
	)

Draws a triangle.

Parameters

x1,y1	Vertex 1 of the triangle.
x2,y2	Vertex 2 of the triangle.
x3,y3	Vertex 3 of the triangle.
color	RGB15/ARGB16 color of the triangle.

glTriangleFilled()

void glTriangleFilled	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	x3,
		int	y3,
		int	color
	)

Draws a filled triangle.

Parameters

x1,y1	Vertex 1 of the triangle.
x2,y2	Vertex 2 of the triangle.
x3,y3	Vertex 3 of the triangle.
color	RGB15/ARGB16 color of the triangle.

glTriangleFilledGradient()

void glTriangleFilledGradient	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	x3,
		int	y3,
		int	color1,
		int	color2,
		int	color3
	)

Draws a triangle in gradient colors.

Parameters

x1,y1	Vertex 1 of the triangle.
x2,y2	Vertex 2 of the triangle.
x3,y3	Vertex 3 of the triangle.
color1	RGB15/ARGB16 color of the vertex 1.
color2	RGB15/ARGB16 color of the vertex 2.
color3	RGB15/ARGB16 color of the vertex 3.