G2*_GetBG3ControlAffine

C Specification

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg23ControlAffine G2_GetBG3ControlAffine( void );
static inline GXBg23ControlAffine G2S_GetBG3ControlAffine( void );

Arguments

None.

Return Values

The settings for BG3.

Description

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

Use the G2_GetBG3ControlAffine function to get the settings for the main 2D engine, and use the G2S_GetBG3ControlAffine function to get the settings for the sub 2D engine.
The following is the definition for GXBg23ControlAffine:

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;
    };
}
GXBg23ControlAffine;

See Also

G2_SetBG3ControlAffine, G2S_SetBG3ControlAffine

Revision History

12/24/2004 Initial version.