# GX_GetDispCnt

## C Specification

  `#include <nitro/gx/gx.h>`
  `GXDispCnt GX_GetDispCnt( void );`

## Arguments

None.

## Return Values

The value of `GXDispCnt` type that indicates the display control register value of the main graphic engine.

## Description

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

`bgMode` | BG mode information. See the `GXBGMode` type of `GX_SetGraphicsMode`.
`bg0_2d3d` | Information that shows whether to allocate BG0 to 3D. See the `GX_BG0_AS_*` type of `GX_SetGraphicsMode`.
`objMapChar` | Character OBJ 1D/2D mapping selection flag. See `GX_SetOBJVRamModeChar`.
`objMapBmp` | Bitmap OBJ mapping selection flag. See `GX_SetOBJVRamModeBmp`.
`blankScr` | 2D display forced blank setting. This parameter stops only the 2D display, and normally this is not used. For ON/OFF control of display, use `GX_DispOff` and `GX_DispOn`.
`visiblePlane` | 2D display plane setting. For more information, see the `GXPlaneMask` type of `GX_SetVisiblePlane`.
`visibleWnd` | Window display setting. For more information, see the `GXWndMask` type of `GX_SetVisibleWnd`.
`dispMode` | Display mode setting. For more information., see the `GXDispMode` type of `GX_SetGraphicsMode`.
`extObjMapChar` | Character OBJ's VRAM capacity setting. See `GX_SetOBJVRamModeChar`.
`extObjMapBmp` | Bitmap OBJ's VRAM capacity setting. See `GX_SetOBJVRamModeBmp`.
`hBlankObjProc` | Sets the OBJ process during the H-Blank. For more information, see `GX_HBlankOBJProc`.
`bgCharOffset` | BG character data offset value setting. See the `GXBGCharOffset` type of `GX_SetBGCharOffset`.
`bgScrOffset` | BG screen data offset value setting. See the `GXBGScrOffset` type of `GX_SetBGScrOffset`.
`bgExtPltt` | BG extended palette enable flag. It is set in the VRAM bank setting function such as `GX_SetBankForBGExtPltt`.
`objExtPltt` | OBJ extended palette enable flag. It is set in the VRAM bank setting function such as `GX_SetBankForOBJExtPltt`.

The type definition of `GXDispCnt` type is shown below.

    typedef union
    {
    u32 raw;
    struct {
    u32             bgMode          :3;
    u32             bg0_2d3d        :1;
    u32             objMapChar      :1;
    u32             objMapBmp       :2;
    u32             blankScr        :1;
    u32             visiblePlane    :5;
    u32             visibleWnd      :3;
    u32             dispMode        :4;
    u32             extObjMapChar   :2;
    u32             extObjMapBmp    :1;
    u32             hBlankObjProc   :1;
    u32             bgCharOffset    :3;
    u32             bgScrOffset     :3;
    u32             bgExtPltt       :1;
    u32             objExtPltt      :1;
            };
    }
    GXDispCnt;

## See Also

## Revision History

12/24/2004 Initial version