GX*_GetVisiblePlane

C Specification

#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 obtains the settings for the main graphics engine, and the GXS_GetVisiblePlane function obtains the settings for the sub graphics engine.

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

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

12/24/2004 Initial version.