G2*_GetBG2Control256x16Affine

Syntax

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg23Control256x16Affine G2_GetBG2Control256x16Affine( void );
static inline GXBg23Control256x16Affine G2S_GetBG2Control256x16Affine( void );

Arguments

None.

Return Values

The settings for BG2.

Description

When BG2 has been set to 256-color x 16 palette Character BG for Affine Extended BG, this gets the settings for BG2 as the GXBg23Control256x16Affine structure.
See the G2_SetBG2Control256x16Affine function for more information on each member.

To use this function, BG2 must be set to 256-color x 16 palette Character BG.

Use the G2_GetBG2Control256x16Affine function to get the settings for the main 2D engine and the G2S_GetBG2Control256x16Affine function to get the settings for the sub 2D engine. The following is the definition for GXBg23Control256x16Affine:

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

See Also

G2_SetBG2Control256x16Affine
G2S_SetBG2Control256x16Affine

Revision History

2007/01/18 Initial version.


CONFIDENTIAL