G2*_GetBG2Control256x16Pltt

C Specification

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg23Control256x16Pltt G2_GetBG2Control256x16Pltt( void );
static inline GXBg23Control256x16Pltt G2S_GetBG2Control256x16Pltt( 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 GXBg23Control256x16Pltt structure. To read about the various members, see G2_SetBG2Control256x16Pltt.
To use this function, BG2 must be set to 256-color x 16 palette Character BG.

The G2_GetBG2Control256x16Pltt function gets the settings for the main 2D engine. Use the G2S_GetBG2Control256x16Pltt function to get the settings for the sub 2D engine.
The following is the definition for GXBg23Control256x16Pltt:

typedef union
{
u16 raw;
struct
    {
u16 priority    :2;
u16 _reserve1   :1;
u16 charBase    :3;
u16 mosaic      :1;
u16 _reserve2   :1;
u16 screenBase  :5;
u16 areaOver    :1;
u16 screenSize  :2;
    };
}
GXBg23Control256x16Pltt;

See Also

G2_SetBG2Control256x16Pltt, G2S_SetBG2Control256x16Pltt

Revision History

12/24/2004 Initial version.