GX_TrySetBankForSubOBJExtPltt

C Specification

#include <nitro/gx/gx_vramcnt.h>

BOOL GX_TrySetBankForSubOBJExtPltt(GXVRamSubOBJExtPltt objExtPltt);

Arguments

objExtPltt Specifies a VRAM bank to allocate to the sub 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 sub 2D engine OBJ extended palette . If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the sub 2D Engine OBJ's 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_SUB_OBJEXTPLTT_NONE A VRAM bank is not allocated to the OBJ Extended palette.
GX_VRAM_SUB_OBJEXTPLTT_0_I The OBJ Extended palette is reserved. VRAM-I is allocated.

The following is the type definition for GXVRamSubOBJExtPltt types.

typedef enum
{
GX_VRAM_SUB_OBJEXTPLTT_NONE = 0x0000,
GX_VRAM_SUB_OBJEXTPLTT_0_I  = GX_VRAM_I
}
GXVRamSubOBJExtPltt;

See Also

GX_SetBankForSubOBJExtPltt, GX_GetSizeOfSubOBJExtPltt, GX_GetBankForSubOBJExtPltt, GX_ResetBankForSubOBJExtPltt, GX_DisableBankForSubOBJExtPltt

Revision History

02/15/2005 Initial version.