GXS_SetOBJVRamModeBmp


C Specification

#include <nitro/gx/gx.h>
void GXS_SetOBJVRamModeBmp(GXOBJVRamModeBmp mode);

Description

This function sets OBJ-VRAM capacity for sub 2D Engine bitmap OBJs and sets mapping mode.

GX_OBJVRAMMODE_BMP_2D_W128 Selects 2D mapping mode with 128 horizontal dots.
GX_OBJVRAMMODE_BMP_2D_W256 Selects 2D mapping mode with 256 horizontal dots.
GX_OBJVRAMMODE_BMP_1D_128K Sets 1D mapping mode with OBJ-VRAM capacity of 128 Kilobytes. The first character name boundary is 128 bytes.
GX_OBJVRAMMODE_BMP_1D_256K Sets 1D mapping mode with OBJ-VRAM capacity of 256 Kilobytes. The first character name boundary is 256 bytes.

The following shows XOBJVRamModeBmp format type definitions:

typedef enum
{
    GX_OBJVRAMMODE_BMP_2D_W128 = (0 << REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 << REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
    GX_OBJVRAMMODE_BMP_2D_W256 = (1 << REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 << REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
    GX_OBJVRAMMODE_BMP_1D_128K = (2 << REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 << REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
    GX_OBJVRAMMODE_BMP_1D_256K = (2 << REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (1 << REG_GX_DISPCNT_EXOBJ_SHIFT + 2)
}
GXOBJVRamModeBmp;

Arguments

mode Mapping mode

Return Values

None

See Also

GXS_SetOBJVRamModeChar

Revision History

02/09/2004 Initial Version