# G2*_GetBG2Control256Bmp

## C Specification

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

      static inline GXBg23Control256Bmp G2_GetBG2Control256Bmp( void );
      static inline GXBg23Control256Bmp G2S_GetBG2Control256Bmp( void );

## Arguments

None.

## Return Values

The settings for BG2.

## Description

When BG2 has been set to 256-color bitmap BG for Affine Expanded BG, this gets the settings for BG2 as the `GXBg23Control256Bmp` structure. To read about the various members, see `G2_SetBG2Control256Bmp`.
To use this function, BG2 must be set to 256-color bitmap BG.
Use the `G2_GetBG2Control256Bmp` function to get the settings for the main 2D engine, and the `G2S_GetBG2Control256Bmp` function to get the settings for the sub 2D engine.
The following is the definition of `GXBg23Control256Bmp`:

    typedef union
    {
    u16 raw;
    struct
        {
    u16 priority    :2;
    u16 _reserve1   :4;
    u16 mosaic      :1;
    u16 _reserve2   :1;
    u16 screenBase  :5;
    u16 areaOver    :1;
    u16 screenSize  :2;
        };
    }
    GXBg23Control256Bmp;

## See Also

`G2_SetBG2Control256Bmp, G2S_SetBG2Control256Bmp`

## Revision History

12/24/2004 Initial version.