GX_SetBankForSubBGExtPltt

C Specification

#include <nitro/gx/gx_vramcnt.h>

void GX_SetBankForSubBGExtPltt(GXVRamSubBGExtPltt bgExtPltt);

Arguments

bgExtPltt Specifies a VRAM bank to allocate to the sub 2D Engine's BG Extended palette

Return Values

None.

Description

This function allocates the specified VRAM bank to the sub 2D Engine's BG Extended palette. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the sub 2D Engine BG Extended palette.
Note:  When the VRAM bank is allocated to the BG Extended palette, the palette information of the BG Extended palette is referenced when 256 colors are specified as the color mode for text BG or 256x16 palette BG is selected. At all other times, the standard palette is referenced.

GX_VRAM_SUB_BGEXTPLTT_NONE The VRAM bank is not allocated to the BG Extended palette.
GX_VRAM_SUB_BGEXTPLTT_0123_H Slots 0 to 3 of the BG Extended palette are reserved. VRAM-H is allocated.

The following is the type definition for GXVRamSubBGExtPltt types.

typedef enum
{
GX_VRAM_SUB_BGEXTPLTT_NONE   = 0x0000,
GX_VRAM_SUB_BGEXTPLTT_0123_H = GX_VRAM_H
}
GXVRamSubBGExtPltt;

See Also

GX_GetBankForSubBGExtPltt, GX_ResetBankForSubBGExtPltt, GX_DisableBankForSubBGExtPltt, GX_GetSizeOfSubBGExtPltt

Revision History

02/09/2004 Initial version