G2S_SetWnd0InsidePlane


C Specification

#include <nitro/gx/g2.h>

void G2S_SetWnd0InsidePlane(int wnd /* GXWndPlaneMask */, BOOL effect );

Description

This function specifies a plane that is displayed inside the sub 2D Engine's window 0. Pass the logical OR value of GXWndPlaneMask to wnd.

GX_WND_PLANEMASK_NONE Does not specify any plane
GX_WND_PLANEMASK_BG0 Specifies BG0
GX_WND_PLANEMASK_BG1 Specifies BG1
GX_WND_PLANEMASK_BG2 Specifies BG2
GX_WND_PLANEMASK_BG3 Specifies BG3
GX_WND_PLANEMASK_OBJ Specifies OBJ


The following are the type definitions for the GXWndPlaneMask type.

typedef enum
{
    GX_WND_PLANEMASK_NONE = 0x0000,
    GX_WND_PLANEMASK_BG0 = 0x0001,
    GX_WND_PLANEMASK_BG1 = 0x0002,
    GX_WND_PLANEMASK_BG2 = 0x0004,
    GX_WND_PLANEMASK_BG3 = 0x0008,
    GX_WND_PLANEMASK_OBJ = 0x0010
}
GXWndPlaneMask;

Arguments

wnd Specifies the plane to be displayed in the window
effect Enables/disables color special effects (alpha-blending and brightness adjustment)

Return Values

None

See Also

G2S_SetWnd1InsidePlane, G2S_SetWndOutsidePlane, G2S_SetWndOBJInsidePlane

Revision History

02/09/2004 Initial Version