G2*_GetBG0Control

C Specification

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg01Control G2_GetBG0Control( void );
static inline GXBg01Control G2S_GetBG0Control( void );

  

Arguments

None.

Return Values

Gets the settings for BG0 (for 2D).

Description

Gets the display settings for BG0 (for 2D) as the structure GXBg01Control. To read about the various members, see G2_SetBG0Control.
The G2_GetBG0Control function gets the settings for the main 2D engine, whereas the G2S_GetBG0Control function gets the settings for the sub 2D engine.
The following is the definition for GXBg01Control:

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

See Also

G2_SetBG0Control, G2S_SetBG0Control

Revision History

12/24/2004 Initial version.