GX_TrySetBankForLCDC

C Specification

#include <nitro/gx/gx_vramcnt.h>

BOOL GX_TrySetBankForLCDC(int lcdc);

Arguments

lcdc   Specifies a VRAM bank to allocate to LCDC

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 LCDC. If the specified VRAM bank is disabled, this allocates the VRAM bank to LCDC. The logical OR of GXVRamLCDC values is used as the argument. The allocation will fail if the designated VRAM bank is exclusion-locked by another library.

GX_VRAM_LCDC_NONE The VRAM bank is not allocated to LCDC.
GX_VRAM_LCDC_A VRAM-A is allocated to LCDC.
GX_VRAM_LCDC_B VRAM-B is allocated to LCDC.
GX_VRAM_LCDC_C VRAM-C is allocated to LCDC.
GX_VRAM_LCDC_D VRAM-D is allocated to LCDC.
GX_VRAM_LCDC_E VRAM-E is allocated to LCDC.
GX_VRAM_LCDC_F VRAM-F is allocated to LCDC.
GX_VRAM_LCDC_G VRAM-G is allocated to LCDC.
GX_VRAM_LCDC_H VRAM-H is allocated to LCDC.
GX_VRAM_LCDC_I VRAM-I is allocated to LCDC.
GX_VRAM_LCDC_ALL All VRAM are allocated to LCDC.

The following indicates the type definition for GXVRamLCDC types.

typedef enum
{
GX_VRAM_LCDC_NONE = 0x0000,
GX_VRAM_LCDC_A = GX_VRAM_A,                    // ARM9: HW_LCDC_VRAM_A  -->  HW_LCDC_VRAM_B
GX_VRAM_LCDC_B = GX_VRAM_B,                    // ARM9: HW_LCDC_VRAM_B  -->  HW_LCDC_VRAM_C
GX_VRAM_LCDC_C = GX_VRAM_C,                    // ARM9: HW_LCDC_VRAM_C  -->  HW_LCDC_VRAM_D
GX_VRAM_LCDC_D = GX_VRAM_D,                    // ARM9: HW_LCDC_VRAM_D  -->  HW_LCDC_VRAM_E
GX_VRAM_LCDC_E = GX_VRAM_E,                    // ARM9: HW_LCDC_VRAM_E  -->  HW_LCDC_VRAM_F
GX_VRAM_LCDC_F = GX_VRAM_F,                    // ARM9: HW_LCDC_VRAM_F  -->  HW_LCDC_VRAM_G
GX_VRAM_LCDC_G = GX_VRAM_G,                    // ARM9: HW_LCDC_VRAM_G  -->  HW_LCDC_VRAM_H
GX_VRAM_LCDC_H = GX_VRAM_H,                    // ARM9: HW_LCDC_VRAM_H  -->  HW_LCDC_VRAM_I
GX_VRAM_LCDC_I = GX_VRAM_I,                    // ARM9: HW_LCDC_VRAM_I  -->  HW_LCDC_VRAM_END
GX_VRAM_LCDC_ALL = 0x01ff                      // ARM9: HW_LCDC_VRAM_A  -->  HW_LCDC_VRAM_END
}
GXVRamLCDC;

See Also

GX_SetBankForLCDC, GX_GetBankForLCDC, GX_DisableBankForLCDC

Revision History

02/15/2005 Initial version.