# G2S_SetBG2Control256Bmp

## C Specification

  `#include <nitro/gx/gx_bgcnt.h>`

      void G2S_SetBG2Control256Bmp(
      GXBGScrSize256Bmp screenSize,
      GXBGAreaOver areaOver,
      GXBGBmpScrBase screenBase
      );

## Arguments

screenSize | screen size
areaOver | Option for out-of-area processing
screenBase | Screen base block

## Return Values

None.

## Description

This function sets the sub 2D Engine's BG2 (in the case of 256-color bitmapped BG).

`GX_BG_SCRSIZE_256BMP_128x128` | Sets screen size to 128x128 pixels (16 kilobytes).
`GX_BG_SCRSIZE_256BMP_256x256` | Sets screen size to 256x256 pixels (64 kilobytes).
`GX_BG_SCRSIZE_256BMP_512x256` | Sets screen size to 512x256 pixels (128 kilobytes).

`GX_BG_AREAOVER_XLU` | Transparent display of the out-of-area region
`GX_BG_AREAOVER_REPEAT` | Wraparound display of the out-of-area region

`GX_BG_BMPSCRBASE_0xnnnnn` | Specifies BG2 screen base block.

The following describes the enumerated type definitions of the arguments.

    typedef enum
    {
    GX_BG_SCRSIZE_256BMP_128x128 = 0,
    GX_BG_SCRSIZE_256BMP_256x256 = 1,
    GX_BG_SCRSIZE_256BMP_512x256 = 2,
    GX_BG_SCRSIZE_256BMP_512x512 = 3
    }
    GXBGScrSize256Bmp;

    typedef enum
    {
    GX_BG_AREAOVER_XLU = 0,
    GX_BG_AREAOVER_REPEAT = 1
    }
    GXBGAreaOver;

    typedef enum
    {
    GX_BG_BMPSCRBASE_0x00000 = 0,
    GX_BG_BMPSCRBASE_0x04000 = 1,
    GX_BG_BMPSCRBASE_0x08000 = 2,
    GX_BG_BMPSCRBASE_0x0c000 = 3,
    GX_BG_BMPSCRBASE_0x10000 = 4,
    GX_BG_BMPSCRBASE_0x14000 = 5,
    GX_BG_BMPSCRBASE_0x18000 = 6,
    GX_BG_BMPSCRBASE_0x1c000 = 7,
    GX_BG_BMPSCRBASE_0x20000 = 8,
    GX_BG_BMPSCRBASE_0x24000 = 9,
    GX_BG_BMPSCRBASE_0x28000 = 10,
    GX_BG_BMPSCRBASE_0x2c000 = 11,
    GX_BG_BMPSCRBASE_0x30000 = 12,
    GX_BG_BMPSCRBASE_0x34000 = 13,
    GX_BG_BMPSCRBASE_0x38000 = 14,
    GX_BG_BMPSCRBASE_0x3c000 = 15,
    GX_BG_BMPSCRBASE_0x40000 = 16,
    GX_BG_BMPSCRBASE_0x44000 = 17,
    GX_BG_BMPSCRBASE_0x48000 = 18,
    GX_BG_BMPSCRBASE_0x4c000 = 19,
    GX_BG_BMPSCRBASE_0x50000 = 20,
    GX_BG_BMPSCRBASE_0x54000 = 21,
    GX_BG_BMPSCRBASE_0x58000 = 22,
    GX_BG_BMPSCRBASE_0x5c000 = 23,
    GX_BG_BMPSCRBASE_0x60000 = 24,
    GX_BG_BMPSCRBASE_0x64000 = 25,
    GX_BG_BMPSCRBASE_0x68000 = 26,
    GX_BG_BMPSCRBASE_0x6c000 = 27,
    GX_BG_BMPSCRBASE_0x70000 = 28,
    GX_BG_BMPSCRBASE_0x74000 = 29,
    GX_BG_BMPSCRBASE_0x78000 = 30,
    GX_BG_BMPSCRBASE_0x7c000 = 31
    }
    GXBGBmpScrBase;

## See Also

G2S_GetBG2Control256Bmp

## Revision History

02/09/2004 Initial version