# G2*_GetBG2ControlText

## C Specification

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

      static inline GXBg23ControlText G2_GetBG2ControlText( void );
      static inline GXBg23ControlText G2S_GetBG2ControlText( void );

## Arguments

None.

## Return Values

The settings for BG2.

## Description

When BG2 has been set to Text BG, this gets the settings for BG2 as the `GXBg23ControlText` structure. To read about the various members, see `G2_SetBG2ControlText`.
To use this function, BG2 must be set to Text BG.
Use the `G2_GetBG2ControlText` function to get the settings for the main 2D engine, and use `G2S_GetBG2ControlText` to get the settings for the sub 2D engine.
The following is the definition for `GXBg23ControlText`:

    typedef union
    {
    u16 raw;
    struct
        {
    u16 priority    :2;
    u16 charBase    :4;
    u16 mosaic      :1;
    u16 colorMode   :1;
    u16 screenBase  :5;
    u16 _reserve    :1;
    u16 screenSize  :2;
        };
    }
    GXBg23ControlText;

## See Also

`G2_SetBG2ControlText, G2S_SetBG2ControlText`

## Revision History

12/24/2004 Initial version.

CONFIDENTIAL