G2*_GetBG1Control

Syntax

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

  

Arguments

None.

Return Values

The display settings for BG1.

Description

Gets the display settings for BG1 as the structure GXBg01Control. See the G2_SetBG1Control function for more information on each member.

Use the G2_GetBG1Control function to get the settings for the main 2D engine and the G2S_GetBG1Control function to get 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_SetBG1Control
G2S_SetBG1Control

Revision History

2004/12/24 Initial version.


CONFIDENTIAL