G2*_GetBG3ControlDCBmp

C Specification

#include <nitro/gx/gx_bgcnt.h>
static inline GXBg23ControlDCBmp G2_GetBG3ControlDCBmp( void );
static inline GXBg23ControlDCBmp G2S_GetBG3ControlDCBmp( void );

Arguments

None.

Return Values

The settings for BG3.

Description

When BG3 has been set to Direct color bitmap BG for Affine Expanded BG, this gets the settings for BG3 as the GXBg23ControlDCBmp structure. To read about the various members, see G2_SetBG3ControlDCBmp.
To use this function, BG3 must be set to Direct color bitmap BG.

Use the G2_GetBG3ControlDCBmp function to get the settings for the main 2D engine, and use G2S_GetBG3ControlDCBmp to get the settings for the sub 2D engine.
The following is the definition for GXBg23ControlDCBmp:

typedef union
{
u16 raw;
struct
    {
u16 priority    :2;
u16 _reserve1   :4;
u16 mosaic      :1;
u16 _reserve2   :1;
u16 screenBase  :5;
u16 areaOver    :1;
u16 screenSize  :2;
    };
}
GXBg23ControlDCBmp;

See Also

G2_SetBG3ControlDCBmp, G2S_SetBG3ControlDCBmp

Revision History

12/24/2004 Initial version.