G2_SetWnd0InsidePlane

C Specification

#include <nitro/gx/g2.h>

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

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.

Description

This function specifies the plane to be displayed inside Window 0. Pass the logical OR value of GXWndPlaneMask type to wnd.

GX_WND_PLANEMASK_NONE No plane is specified.
GX_WND_PLANEMASK_BG0 Indicates that BG0 is visible.
GX_WND_PLANEMASK_BG1 Indicates that BG1 is visible.
GX_WND_PLANEMASK_BG2 Indicates that BG2 is visible.
GX_WND_PLANEMASK_BG3 Indicates that BG3 is visible.
GX_WND_PLANEMASK_OBJ Indicates that OBJs are visible.


The type definitions for GXWndPlaneMask are indicated below.

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;

See Also

G2_SetWnd1InsidePlane, G2_SetWndOutsidePlane, G2_SetWndOBJInsidePlane, G2_GetWnd0InsidePlane

Revision History

01/19/2004 Initial version.