HEL Library: Object Palette Functions

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

Blend between 16 color object palettes.

The hel_PalObjBlend16 function blends colors between two 16 color object 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_PalObjBlend256	(	const u16 *	pPaletteA,
		const u16 *	pPaletteB,
		u32	Weight
	)

Blend between 256 color object palettes.

The hel_PalObjBlend256 function blends colors between two 256 color object 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_PalObjBlend16

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

Clear colors of the object palette with a specific color.

The hel_PalObjClear function clears a part of the object palette with the specified Color.

Parameters:

`[in]`	Index	Palette entry to start at (0..255)
`[in]`	Count	Amount of palette entries to clear
`[in]`	Color	Color in BGR555 format

See also:: hel_PalClear, hel_PalObjClear16, hel_PalObjClear256

void hel_PalObjClear16 ( u32 PaletteBank )

Clear a 16 color object palette.

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

Parameters:

[in] PaletteBank The palette-bank (0..15)

See also:: hel_PalObjClear, hel_PalObjClear256

void hel_PalObjClear256 ( void )

Clear entire object palette.

The hel_PalObjClear256 function clears the entire object palette and set all colors to black.

See also:: hel_PalObjClear, hel_PalObjClear16

void hel_PalObjInvert	(	u32	Index,
		u32	Count
	)

Invert colors of the object palette.

The hel_PalObjInvert function inverts colors of a given range in the object palette memory.

Parameters:

`[in]`	Index	Index of first color to invert (0..255)
`[in]`	Count	Amount of colors to invert

See also:: hel_PalObjClear256, hel_PalObjClear16

void hel_PalObjInvert16 ( u32 PaletteBank )

Invert colors of a 16 color object palette-bank.

The hel_PalObjInvert16 function inverts the colors of the 16color object palette, specified by PaletteBank.

Parameters:

[in] PaletteBank The palette-bank (0..15)

See also:: hel_PalObjInvert256

void hel_PalObjInvert256 ( void )

Invert colors of entire object palette.

The hel_PalObjInvert256 function inverts the colors of the entire object palette.

See also:: hel_PalObjInvert16

void hel_PalObjLoad	(	const u16 *	SourceData,
		u32	NumColors
	)

Load an object palette.

The hel_PalObjLoad function loads an object palette.

Parameters:

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

void hel_PalObjLoad16	(	const u16 *	SourceData,
		u32	PaletteBank
	)

Load a 16 color object palette.

The hel_PalObjLoad16 function loads a 16 color object 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_PalObjLoad16UnComp	(	const u16 *	SourceData,
		u32	PaletteBank,
		u32	CompressionType
	)

Load a 16 color compressed object palette.

The hel_PalObjLoad16UnComp function loads a compressed 16 color object 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_PalObjLoad256UnComp, hel_PalObjLoad16, hel_SwiUnComp

void hel_PalObjLoad256 ( const u16 * SourceData )

Load a 256 color object palette.

The hel_PalObjLoad256 function loads a 256 color object palette

Parameters:

[in] SourceData Pointer to palette-data. Address must be halfword-aligned.

void hel_PalObjLoad256UnComp	(	const u16 *	SourceData,
		u32	CompressionType
	)

Load a 256 color compressed object palette.

The hel_PalObjLoad256UnComp function loads a compressed 256 color object palette

Parameters:

`[in]`	SourceData	Pointer to palette-data
`[in]`	CompressionType	Type of Compression. See `COMPRESSION_TYPE_*` predefined values.

See also:: hel_PalObjLoad16UnComp, hel_PalObjLoad256, hel_SwiUnComp

void hel_PalObjSave16	(	void *	pDest,
		u32	PaletteBank
	)

Save a 16 color object palette.

The hel_PalObjSave16 function copies a 16 color object 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. This address must be halfword aligned.
`[in]`	PaletteBank	Source palette-bank (0..15)

void hel_PalObjSave256 ( void * pDest )

Save a 256 color object palette.

The hel_PalObjSave256 function copies the 256 color object 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.

Object Palette Functions
[Palette System]

Functions

Function Documentation

Object Palette Functions [Palette System]

Functions

Function Documentation

Object Palette Functions
[Palette System]