G2*_GetBG2ControlLargeBmp

# G2_GetBG2ControlLargeBmp

## C Specification

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

      static inline GXBg23ControlDCBmp G2_GetBG2ControlLargeBmp( void );

## Arguments

None.

## Return Values

The settings for BG2.

## Description

When BG2 has been set to Large-screen 256-color bitmap BG, this gets the settings for BG2 as the `GXBg2ControlLargeBmp` structure. To read about the various members, see `G2_SetBG2ControlLargeBmp`.
To use this function, BG2 must be set to Large-screen 256-color bitmap BG.
The following is the definition for `GXBg2ControlLargeBmp`:

    typedef union
    {
        u16 raw;
        struct
        {
            u16 priority    :2;
            u16 _reserve1   :4;
            u16 mosaic      :1;
            u16 _reserve2   :6;
            u16 areaOver    :1;
            u16 screenSize  :2;
        };
    }
    GXBg2ControlLargeBmp;

## See Also

G2_SetBG2ControlLargeBmp

## Revision History

12/24/2004 Initial version.

CONFIDENTIAL