kmSetPaletteMode

Sets the on-chip palette mode.

KMSTATUS KMAPI
kmSetPaletteMode(
IN KMPALETTEMODE Palettemode
)

Description:

This function specifies a mode of the on-chip palette used by the palettized texture. A palette has 1,024 entries. For details of how to set a palette, see the description of kmSetPaletteData.

Caution:

Palette data setting (kmSetPaletteData/kmSetPaletteBank/kmSetPaletteBankData) cannot precede palette mode setting (kmSetPaletteMode). If the palette mode type does not match the palette data type, invalid data will be set in the palette register.

Parameters:

Palettemode(input)
This parameter specifies the BPP mode of the palette. One of the following can be selected.

PaletteMode | Meaninng
--- | ---
KM_PALETTE_16BPP_ARGB1555 | 16BPP mode, ARGB1555 format
KM_PALETTE_16BPP_RGB565 | 16BPP mode, RGB565 format
KM_PALETTE_16BPP_ARGB4444 | 16BPP mode, ARGB4444 format
KM_PALETTE_32BPP_ARGB8888 | 32BPP mode, ARGB8888 format

Return values:

Value | Explanation
--- | ---
KMSTATUS_SUCCESS | Success

kmSetPaletteMode