GX_TrySetBankForOBJExtPltt

C Specification

#include <nitro/gx/gx_vramcnt.h>

BOOL GX_TrySetBankForOBJExtPltt(GXVRamOBJExtPltt objExtPltt);

Arguments

objExtPltt Specifies a VRAM bank to allocate to the main 2D Engine's OBJ Extended palette

Return Values

Returns TRUE if the VRAM bank is allocated as normal. Returns FALSE if the VRAM bank to be allocated is locked by another library.

Description

Attempts to allocate a VRAM bank to the main 2D engine OBJ extended palette. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the Main 2D Engine's OBJ Extended palette. The allocation will fail if the designated VRAM bank is exclusion-locked by another library.
Note: When the OBJ Extended palette is allocated, the 256-color OBJ uses the OBJ Extended palette. However, 16-color OBJs normally use the standard palette.

GX_VRAM_OBJEXTPLTT_NONE A VRAM bank is not allocated to the OBJ Extended palette.
GX_VRAM_OBJEXTPLTT_8_F The OBJ Extended palette is reserved. VRAM-F is allocated.
GX_VRAM_OBJEXTPLTT_8_G The OBJ Extended palette is reserved. VRAM-G is allocated.


The following is the type definition for GXVRamOBJExtPltt types.

typedef enum
{
GX_VRAM_OBJEXTPLTT_NONE = 0x0000,
GX_VRAM_OBJEXTPLTT_0_F = GX_VRAM_F,           // OBJExtPltt
GX_VRAM_OBJEXTPLTT_0_G = GX_VRAM_G            // OBJExtPltt
}
GXVRamOBJExtPltt;

See Also

GX_SetBankForOBJExtPltt, GX_GetSizeOfOBJExtPltt, GX_GetBankForOBJExtPltt, GX_ResetBankForOBJExtPltt, GX_DisableBankForOBJExtPltt

Revision History

02/15/2005 Initial version.