GXS_SetVisiblePlane

Syntax

#include <nitro/gx/gx.h>

void GXS_SetVisiblePlane(int plane);

Arguments

plane Specifies display plane with logical sum of GXPlaneMask types

Return Values

None.

Description

This function selects a plane to display. The argument is the logical sum of the GXPlaneMask type values.

GX_PLANEMASK_NONE Indicates that nothing is visible.
GX_PLANEMASK_BG0 Specifies BG0.
GX_PLANEMASK_BG1 Specifies BG1.
GX_PLANEMASK_BG2 Specifies BG2.
GX_PLANEMASK_BG3 Specifies BG3.
GX_PLANEMASK_OBJ Specifies OBJs.

The type definition of GXPlaneMask type is shown below.

typedef enum
{
    GX_PLANEMASK_NONE = 0x00,
    GX_PLANEMASK_BG0 = 0x01,
    GX_PLANEMASK_BG1 = 0x02,
    GX_PLANEMASK_BG2 = 0x04,
    GX_PLANEMASK_BG3 = 0x08,
    GX_PLANEMASK_OBJ = 0x10
}
GXPlaneMask;

See Also

GXS_SetVisibleWnd, GXS_GetVisiblePlane

Revision History

2004/02/09 Initial version.


CONFIDENTIAL