GXS_GetDispCnt

Syntax

#include <nitro/gx/gx.h>

GXSDispCnt GXS_GetDispCnt( void );

Arguments

None.

Return Values

The value of the GXSDispCnt type that indicates the display control register value of the sub graphic engine.

Description

Obtains the value of the display control register of the sub graphics engine. GXDispCnt type contains the following information.

bgMode BG mode information. See the GXBGMode type in the GXS_SetGraphicsMode function.
objMapChar Character OBJ 1D/2D mapping selection flag.
See the GXS_SetOBJVRamModeChar function.
objMapBmp Bitmap OBJ mapping selection flag.
See the GXS_SetOBJVRamModeBmp function.
blankScr 2D display forced blank setting. Normally this parameter is not used and dispMode parameter is used for ON/OFF control of the display.
visiblePlane 2D display plane setting. For more information, see the GXPlaneMask type in the GXS_SetVisiblePlane function.
visibleWnd Window display setting. For more information, see the GXWndMask type in the GXS_SetVisibleWnd function.
dispMode Display mode setting. It is used by the GXS_DispOn and GXS_DispOff functions.
extObjMapChar Character OBJ's VRAM capacity setting.
See the GXS_SetOBJVRamModeChar function.
hBlankObjProc Sets the OBJ process during the H-Blank. For more information, see the GXS_HBlankOBJProc function.
bgExtPltt BG extended palette enable flag. It is set in VRAM bank setting functions, such as GX_SetBankForSubBGExtPltt.
objExtPltt OBJ extended palette enable flag. It is set in VRAM bank setting functions, such as GX_SetBankForSubOBJExtPltt.

The type definition of GXDispCnt type is shown below.

typedef union
{
    u32 raw;
    struct {
        u32             bgMode          :3;
        u32     _reserve1       :1;
        u32             objMapChar      :1;
        u32             objMapBmp       :2;
        u32             blankScr        :1;
        u32             visiblePlane    :5;
        u32             visibleWnd      :3;
        u32             dispMode        :1;
        u32     _reserve2       :3;
        u32             extObjMapChar   :2;
        u32     _reserve3       :1;
        u32             hBlankObjProc   :1;
        u32     _reserve4       :6;
        u32             bgExtPltt       :1;
        u32             objExtPltt      :1;
    };
}
GXSDispCnt;

See Also

Revision History

2004/12/24 Initial version.


CONFIDENTIAL