image.h File Reference

An image abstraction for working with image data. More...

#include <nds/arm9/video.h>
#include <nds/arm9/pcx.h>

Data Structures
struct	RGB_24
	holds a red green blue triplet More...
struct	sImage
	A generic image structure. More...
Functions
void	image24to16 (sImage *img)
	Converts a 24 bit image to 16 bit.
void	image8to16 (sImage *img)
	Converts an 8 bit image to 16 bit setting the alpha bit.
void	image8to16trans (sImage *img, u8 transparentColor)
	Converts an 8 bit image to 16 bit with alpha bit cleared for the supplied palette index.
void	imageDestroy (sImage *img)
	frees the image data. Only call if the image data was returned from an image loader
void	imageTileData (sImage *img)
	Tiles 8 bit image data into a sequence of 8x8 tiles.

---

Detailed Description

An image abstraction for working with image data.

Image data pointers must be allocated using malloc as the conversion rutiens will free the pointers and allocate new data. As such any loader implemented utilizing this structure must use malloc() to allocate the image pointer data.

---

Function Documentation

void image24to16

(

sImage *

img

)

Converts a 24 bit image to 16 bit.

Parameters:

img

a pointer to image to manipulate

void image8to16

(

sImage *

img

)

Converts an 8 bit image to 16 bit setting the alpha bit.

Parameters:

img

a pointer to image to manipulate

Examples:

Graphics/3D/nehe/lesson06/source/nehe6.cpp, Graphics/3D/nehe/lesson07/source/nehe7.cpp, Graphics/3D/nehe/lesson08/source/nehe8.cpp, Graphics/3D/nehe/lesson10/source/nehe10.cpp, Graphics/3D/nehe/lesson10b/source/nehe10b.cpp, Graphics/3D/nehe/lesson11/source/nehe11.cpp, and input/Touch_Pad/touch_look/source/main.cpp.

void image8to16trans	(	sImage *	img,
		u8	transparentColor
	)

Converts an 8 bit image to 16 bit with alpha bit cleared for the supplied palette index.

Parameters:

	img	a pointer to image to manipulate
	transparentColor	Color indexes equal to this value will have the alpha bit clear

Examples:

Graphics/3D/nehe/lesson09/source/nehe9.cpp.

void imageDestroy

(

sImage *

img

)

frees the image data. Only call if the image data was returned from an image loader

Parameters:

img

a pointer to image to manipulate (the image data will be free() )

Examples:

Graphics/3D/nehe/lesson06/source/nehe6.cpp, Graphics/3D/nehe/lesson07/source/nehe7.cpp, Graphics/3D/nehe/lesson08/source/nehe8.cpp, Graphics/3D/nehe/lesson09/source/nehe9.cpp, and input/Touch_Pad/touch_look/source/main.cpp.

void imageTileData

(

sImage *

img

)

Tiles 8 bit image data into a sequence of 8x8 tiles.

Parameters:

img

a pointer to image to manipulate

Examples:

Graphics/Sprites/fire_and_sprites/source/main.cpp.