// HEL Library \\

 
Main Page | Modules | Related Pages

Fade Functions

Functions


Function Documentation

TFadeInfo hel_FadeInit void *  pPalette,
u8  PalMode,
u8  ColMode,
u8  PalNo
 

Init a palette fader.

The hel_FadeInit function initializes a TFadeInfo structure, what you need for later usage with other fading-functions.

Parameters:
pPalette A pointer to the palette (array) which you want to use to fade either in or out.
PalMode The palette mode. 0=background palette, 1=object palette. You can also use one of these defines:
  • FADE_PALETTE_BG
  • FADE_PALETTE_OBJ
ColMode Color mode. 0=16 colors, 1=256 colors. You can also use one of these defines:
  • FADE_COLORS_16
  • FADE_COLORS_256
PalNo If you want to fade a 16 color palette, you have to select the palette bank using this parameter. Must between 0..15! If you want to fade a 256 color palette, just set it to 0.
Returns:
An initialized TFadeInfo structure
See also:
hel_FadePalette, hel_FadeReset

u8 hel_FadePalette TFadeInfo *  pFadeInfo,
s8  AmountPerCall
 

Reset a palette fader structure.

The hel_FadePalette function fades a palette, depending on the information hold by pFadeInfo, either in or out.

Parameters:
pFadeInfo Pointer to an initialized TFadeInfo structure
AmountPerCall The amount you want to fade the palette. Use positive values to fade the palette in and negative to fade it out.
Returns:
Returns true when it completely faded in or out, otherwise false
See also:
hel_FadeInit, hel_FadeReset

u8 hel_FadePalette TFadeInfo *  pFadeInfo,
s32  AmountPerCall
 

Reset a palette fader structure.

The hel_FadePalette function fades a palette, depending on the information hold by pFadeInfo, either in or out.

Parameters:
pFadeInfo Pointer to an initialized TFadeInfo structure
AmountPerCall The amount you want to fade the palette. A value of 8 equals to one pixel per go. Use positive values to fade the palette in and negative to fade it out.
Returns:
Returns true when it completely faded in or out, otherwise false
See also:
hel_FadeInit, hel_FadeReset

void hel_FadeReset TFadeInfo *  pFadeInfo  ) 
 

Reset a palette fader structure.

The hel_FadeReset function resets the palette-fader specified by pFadeInfo, so you can use it again after it's completely faded in or out.

Parameters:
pFadeInfo Pointer to an initialized TFadeInfo structure
See also:
hel_FadeInit, hel_FadePalette


Generated on Sun May 22 18:53:56 2005 by DoxyGen 1.3.9.1