G2*_GetBG3ControlText

C Specification

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg23ControlText G2_GetBG3ControlText( void );
static inline GXBg23ControlText G2S_GetBG3ControlText( void );

Arguments

None.

Return Values

The settings for BG3.

Description

When BG3 has been set to Text BG, this gets the settings for BG3 as the GXBg23ControlText structure. To read about the various members, see G2_SetBG3ControlText.
To use this function, BG3 must be set to Text BG.

Use the G2_GetBG3ControlText function to get the settings for the main 2D engine, and use G2S_GetBG3ControlText 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_SetBG3ControlText, G2S_SetBG3ControlText

Revision History

12/24/2004 Initial version.