# GXS_SetOBJVRamModeBmp

## Syntax

      #include <nitro/gx/gx.h>

      void GXS_SetOBJVRamModeBmp(GXOBJVRamModeBmp mode);

## Arguments

mode | Mapping mode

## Return Values

None.

## 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 pixels.
`GX_OBJVRAMMODE_BMP_2D_W256` | Selects 2D mapping mode with 256 horizontal pixels.
`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` | This setting is prohibited with a sub-2D engine.

The following shows `GXOBJVRamModeBmp` format type definitions:

    typedef enum
    {
        GX_OBJVRAMMODE_BMP_2D_W128_32K = (0 << REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 << REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
        GX_OBJVRAMMODE_BMP_2D_W256_32K = (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;

## See Also

`GXS_SetOBJVRamModeChar, GXS_GetOBJVRamModeBmp`

## Revision History

2004/02/09 Initial version.

CONFIDENTIAL