libnds
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Typedefs | Functions
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...
 

Typedefs

typedef struct RGB_24 RGB_24
 holds a red green blue triplet
 
typedef struct sImage sImage
 A generic image structure.
 

Functions

void image24to16 (sImage *img)
 Converts a 24 bit image to 16 bit. More...
 
void image8to16 (sImage *img)
 Converts an 8 bit image to 16 bit setting the alpha bit. More...
 
void image8to16trans (sImage *img, u8 transparentColor)
 Converts an 8 bit image to 16 bit with alpha bit cleared for the supplied palette index. More...
 
void imageDestroy (sImage *img)
 frees the image data. Only call if the image data was returned from an image loader More...
 
void imageTileData (sImage *img)
 Tiles 8 bit image data into a sequence of 8x8 tiles. More...
 

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
imga pointer to image to manipulate
void image8to16 ( sImage img)

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

Parameters
imga pointer to image to manipulate
void image8to16trans ( sImage img,
u8  transparentColor 
)

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

Parameters
imga pointer to image to manipulate
transparentColorColor indexes equal to this value will have the alpha bit clear
void imageDestroy ( sImage img)

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

Parameters
imga pointer to image to manipulate (the image data will be free() )
void imageTileData ( sImage img)

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

Parameters
imga pointer to image to manipulate