Gif functions


Functions

u16 PA_GetGifWidth (void *gif)
 Get a Gif's width in pixels.
u16 PA_GetGifHeight (void *gif)
 Get a Gif's height in pixels.
void PA_LoadGifXY (u8 screen, s16 x, s16 y, void *gif)
 Load a Gif on a 16 bit background... Don't forget to Init the background !
void PA_LoadGif (u8 screen, void *gif)
 Load a Gif on a 16 bit background... Don't forget to Init the background !
void PA_GifAnimSpeed (float speed)
 Set the gif's speed.
void PA_GifAnimStop (void)
 Stop a Gif animation.
void PA_GifAnimPause (void)
 Pause a Gif animation.
void PA_GifAnimPlay (void)
void PA_GifSetStartFrame (s32 StartFrame)
 Set the Gif's starting frame number.
void PA_GifSetEndFrame (s32 EndFrame)
 Set the Gif's ending frame number.
s32 PA_GifGetFrame (void)
 Return's the gif's current frame.
u8 * PA_GifToTiles (void *gif, u16 *temppal)
 Export Gif to a friendly 8x8 tile format, allowing it to be used to create sprites and backgrounds ! Returns a pointer towards your sprite gfx.

Detailed Description

Manages everything about gif files.

Function Documentation

u16 PA_GetGifHeight ( void *  gif  )  [inline]

Get a Gif's height in pixels.

Parameters:
gif Gif image...

u16 PA_GetGifWidth ( void *  gif  )  [inline]

Get a Gif's width in pixels.

Parameters:
gif Gif image...

inline void PA_GifAnimPause ( void   )  [inline]

Pause a Gif animation.

void PA_GifAnimPlay ( void   )  [inline]

inline void PA_GifAnimSpeed ( float  speed  )  [inline]

Set the gif's speed.

Parameters:
speed 1 for normal, 2 for 2x, 0.5 for half speed...

inline void PA_GifAnimStop ( void   )  [inline]

Stop a Gif animation.

Unpause a Gif animation.

inline s16 PA_GifGetFrame ( void   )  [inline]

Return's the gif's current frame.

inline void PA_GifSetEndFrame ( s32  EndFrame  )  [inline]

Set the Gif's ending frame number.

Parameters:
EndFrame Ending frame... (100000 if you want to be sure ^^)

inline void PA_GifSetStartFrame ( s32  StartFrame  )  [inline]

Set the Gif's starting frame number.

Parameters:
StartFrame Starting frame... (0 to start from beginning)

void PA_GifToTiles ( void *  gif,
u16 *  temppal 
)

Export Gif to a friendly 8x8 tile format, allowing it to be used to create sprites and backgrounds ! Returns a pointer towards your sprite gfx.

Parameters:
gif Your gif file...
temppal A 256 u16 array that will receive the palette info to load

inline void PA_LoadGif ( u8  screen,
void *  gif 
) [inline]

Load a Gif on a 16 bit background... Don't forget to Init the background !

Parameters:
screen Chose de screen (0 or 1)
gif Gif image...

inline void PA_LoadGifXY ( u8  screen,
s16  x,
s16  y,
void *  gif 
) [inline]

Load a Gif on a 16 bit background... Don't forget to Init the background !

Parameters:
screen Chose de screen (0 or 1)
x X position on the screen
y Y position on the screen
gif Gif image...


Generated on Sat Jun 13 12:55:14 2009 for PAlib - Programmer's Arsenal by  doxygen 1.5.8