GX*_GetVisiblePlane

構文

#include <nitro/gx/gx.h>

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

引数

なし。

返り値

GXPlaneMask型の論理和で表示面を返します。

説明

表示する面を取得します。GXPlaneMask型の値で論理和をとったものが返り値となります。
GX_GetVisiblePlane() ではメイングラフィックスエンジンの、GXS_GetVisiblePlane() ではサブグラフィックスエンジンの設定を取得することができます。

`GX_PLANEMASK_NONE`	何も指定しません。
`GX_PLANEMASK_BG0`	BG0を指定します。
`GX_PLANEMASK_BG1`	BG1を指定します。
`GX_PLANEMASK_BG2`	BG2を指定します。
`GX_PLANEMASK_BG3`	BG3を指定します。
`GX_PLANEMASK_OBJ`	OBJを指定します。

以下にGXPlaneMask型の型定義を示しておきます。

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;

参照

GX_GetVisibleWnd, GX_SetVisiblePlane, GXS_SetVisiblePlane

履歴

Ver. 2004/12/24