GX*_GetVisiblePlane

Syntax

#include <nitro/gx/gx.h>

int GX_GetVisiblePlane( void );
int GXS_GetVisiblePlane( void );

Arguments

None.

Return Values

Returns the display plane with the logical sum of GXPlaneMask type.

Description

Obtains the set of visible planes. The function returns the logical sum of GXPlaneMask values. The GX_GetVisiblePlane function gets the settings for the main graphics engine, and the GXS_GetVisiblePlane function gets the settings for the sub graphics engine.

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

GX_GetVisibleWnd, GX_SetVisiblePlane, GXS_SetVisiblePlane

Revision History

2004/12/24 Initial version.


CONFIDENTIAL