Background Palette Functions
[Palette System]


Functions

void hel_PalBgBlend16 (const u16 *pPaletteA, const u16 *pPaletteB, u32 PaletteBank, u32 Weight)
 Blend between 16 color background palettes.
void hel_PalBgBlend256 (const u16 *pPaletteA, const u16 *pPaletteB, u32 Weight)
 Blend between 256 color background palettes.
void hel_PalBgClear (u32 Index, u32 Count, u32 Color)
 Clear a part of the background palette with a specific color.
void hel_PalBgClear16 (u32 PaletteBank)
 Clear a 16 color background palette.
void hel_PalBgClear256 (void)
 Clear entire background palette.
void hel_PalBgInvert (u32 Index, u32 Count)
 Invert colors of the background palette.
void hel_PalBgInvert16 (u32 PaletteBank)
 Invert colors of a 16 color background palette-bank.
void hel_PalBgInvert256 (void)
 Invert colors of entire background palette.
void hel_PalBgLoad (const u16 *SourceData, u32 NumColors)
 Load a background palette.
void hel_PalBgLoad16 (const u16 *SourceData, u32 PaletteBank)
 Load a 16 color background palette.
void hel_PalBgLoad16UnComp (const u16 *SourceData, u32 PaletteBank, u32 CompressionType)
 Load a 16 color compressed background palette.
void hel_PalBgLoad256 (const u16 *SourceData)
 Load a 256 color background palette.
void hel_PalBgLoad256UnComp (const u16 *SourceData, u32 CompressionType)
 Load a 256 color compressed background palette.
void hel_PalBgSave16 (void *pDest, u32 PaletteBank)
 Save a 16 color background palette.
void hel_PalBgSave256 (void *pDest)
 Save a 256 color background palette.

Function Documentation

void hel_PalBgBlend16 ( const u16 *  pPaletteA,
const u16 *  pPaletteB,
u32  PaletteBank,
u32  Weight 
)

Blend between 16 color background palettes.

The hel_PalBgBlend16 function blends colors between two 16 color background palettes and stores the resulting color into Vram.

Parameters:
[in] pPaletteA First source palette
[in] pPaletteB Second source palette
[in] PaletteBank Target palette bank. This must be between 0..15
[in] Weight Blendweight. The Weight can be between 0..31. 0 means colors are completely taken from pPaletteA, 31 means colors are completely taken from pPaletteB.
See also:
hel_PalBgBlend256

void hel_PalBgBlend256 ( const u16 *  pPaletteA,
const u16 *  pPaletteB,
u32  Weight 
)

Blend between 256 color background palettes.

The hel_PalBgBlend256 function blends colors between two 256 color background palettes and stores the resulting color into Vram.

Parameters:
[in] pPaletteA First source palette
[in] pPaletteB Second source palette
[in] Weight Blendweight. The Weight can be between 0..31. 0 means colors are completely taken from pPaletteA, 31 means colors are completely taken from pPaletteB.
See also:
hel_PalBgBlend16

void hel_PalBgClear ( u32  Index,
u32  Count,
u32  Color 
)

Clear a part of the background palette with a specific color.

The hel_PalBgClear function clears a part of the background palette with the specified Color.

Parameters:
[in] Index Palette entry to start at (0..254)
[in] Count Amount of palette entries to clear
[in] Color Color in BGR555 format
See also:
hel_PalClear, hel_PalBgClear16, hel_PalBgClear256

void hel_PalBgClear16 ( u32  PaletteBank  ) 

Clear a 16 color background palette.

The hel_PalBgClear16 function clears the 16 color background palette specified by PaletteBank and sets all its colors to black.

Parameters:
[in] PaletteBank The palette-bank (0..15)
See also:
hel_PalBgClear, hel_PalBgClear256

void hel_PalBgClear256 ( void   ) 

Clear entire background palette.

The hel_PalBgClear256 function clears the entire background palette and set all colors to black.

See also:
hel_PalBgClear, hel_PalBgClear16

void hel_PalBgInvert ( u32  Index,
u32  Count 
)

Invert colors of the background palette.

The hel_PalBgInvert function inverts colors of a given range in the background palette memory.

Parameters:
[in] Index Index of first color to invert (0..255)
[in] Count Amount of colors to invert
See also:
hel_PalBgClear256, hel_PalBgClear16

void hel_PalBgInvert16 ( u32  PaletteBank  ) 

Invert colors of a 16 color background palette-bank.

The hel_PalBgInvert16 function inverts the colors of the 16color background palette, specified by PaletteBank.

Parameters:
[in] PaletteBank The palette-bank (0..15)
See also:
hel_PalBgInvert256

void hel_PalBgInvert256 ( void   ) 

Invert colors of entire background palette.

The hel_PalBgInvert256 function inverts the colors of the entire background palette.

See also:
hel_PalBgInvert16

void hel_PalBgLoad ( const u16 *  SourceData,
u32  NumColors 
)

Load a background palette.

The hel_PalBgLoad function loads a background palette.

Parameters:
[in] SourceData Pointer to palette-data. Address must be halfword-aligned.
[in] NumColors Number of colors to load.

void hel_PalBgLoad16 ( const u16 *  SourceData,
u32  PaletteBank 
)

Load a 16 color background palette.

The hel_PalBgLoad16 function loads a 16 color background palette to the bank specified by PaletteBank

Parameters:
[in] SourceData Pointer to palette-data. Address must be halfword-aligned.
[in] PaletteBank The palette-bank (0..15)

void hel_PalBgLoad16UnComp ( const u16 *  SourceData,
u32  PaletteBank,
u32  CompressionType 
)

Load a 16 color compressed background palette.

The hel_PalBgLoad256UnComp function loads a compressed 16 color background palette

Parameters:
[in] SourceData Pointer to palette-data
[in] PaletteBank The palette-bank (0..15)
[in] CompressionType Type of Compression. See COMPRESSION_TYPE_* predefined values.
See also:
hel_PalBgLoad256UnComp, hel_PalBgLoad16, hel_SwiUnComp

void hel_PalBgLoad256 ( const u16 *  SourceData  ) 

Load a 256 color background palette.

The hel_PalBgLoad256 function loads a 256 color background palette to Vram.

Parameters:
SourceData Pointer to palette-data. Address must be halfword-aligned.

void hel_PalBgLoad256UnComp ( const u16 *  SourceData,
u32  CompressionType 
)

Load a 256 color compressed background palette.

The hel_PalBgLoad256UnComp function loads a compressed 256 color background palette

Parameters:
[in] SourceData Pointer to palette-data
[in] CompressionType Type of Compression. See COMPRESSION_TYPE_* predefined values.
See also:
hel_PalBgLoad16UnComp, hel_PalBgLoad256, hel_SwiUnComp

void hel_PalBgSave16 ( void *  pDest,
u32  PaletteBank 
)

Save a 16 color background palette.

The hel_PalObjSave16 function copies a 16 color background palette from Vram to the memory location specified by pDest.

Parameters:
[in] pDest Destination address, must point to an allocated buffer of at least 16 halfwords. The destination address must be halfword-aligned.
[in] PaletteBank Source palette-bank (0..15)

void hel_PalBgSave256 ( void *  pDest  ) 

Save a 256 color background palette.

The hel_PalBgSave256 function copies the 256 color background palette from VRAM to the memory location specified by pDest.

Parameters:
[in] pDest Destination address, must point to an allocated buffer of at least 256 halfwords. The destination address must be halfword-aligned.


Generated on Sat Aug 12 13:54:10 2006 for HEL 2 Library by  doxygen 1.4.7