# GX_SetOBJVRamModeBmp

## C Specification

      #include <nitro/gx/gx.h>

      void GX_SetOBJVRamModeBmp(GXOBJVRamModeBmp mode);

## Arguments

mode | Mapping mode

## Return Values

None.

## Description

This function sets OBJ-VRAM capacity for a bitmapp OBJ, 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` | Sets 1D mapping mode with OBJ-VRAM capacity of 256 Kilobytes. The first character name boundary is 256 bytes.

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;

    // OBSOLETE: These macros will be removed in the future release.
    #define GX_OBJVRAMMODE_BMP_2D_W128_32K GX_OBJVRAMMODE_BMP_2D_W128
    #define GX_OBJVRAMMODE_BMP_2D_W256_32K GX_OBJVRAMMODE_BMP_2D_W256

## See Also

`GX_SetOBJVRamModeChar, GX_GetOBJVRamModeBmp`

## Revision History

02/09/2004

- Changed the enum type values `GX_OBJVRAMMODE_BMP_2D_W128_32K` and `GX_OBJVRAMMODE_BMP_2D_W256_32K` to `GX_OBJVRAMMODE_BMP_2D_W128` and `GX_OBJVRAMMODE_BMP_2D_W256`

01/19/2004 Initial version