1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3 4<head> 5<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 7<META http-equiv="Content-Style-Type" content="text/css"> 8<title>GXS_GetDispCnt</title> 9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13 14<h1 align="left">GXS_GetDispCnt <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></H1> 15<H2>Syntax</H2> 16 17<dl> 18 <dd> 19<CODE>#include <nitro/gx/gx.h></CODE><BR> 20 <BR> 21 <CODE>GXSDispCnt GXS_GetDispCnt( void );</CODE></dd> 22</dl><h2>Arguments</h2> 23<P>None.</P> 24<h2>Return Values</h2> 25<p>The value of the <code>GXSDispCnt</code> type that indicates the display control register value of the sub graphic engine.</p> 26<H2>Description</H2> 27<P>Obtains the value of the display control register of the sub graphics engine. <code>GXDispCnt</code> type contains the following information.</P> 28<TABLE border="1"> 29 <TBODY> 30 <TR> 31 <TD width="30%"><B><I><CODE>bgMode</CODE></I></B></TD> 32 <TD width="70%">BG mode information. See the <CODE>GXBGMode</CODE> type in the <CODE><A href="GXS_SetGraphicsMode.html">GXS_SetGraphicsMode</A></CODE> function.</TD> 33 </TR> 34 <TR> 35 <TD width="30%"><I><B><CODE>objMapChar</CODE></B></I></TD> 36 <TD width="70%">Character OBJ 1D/2D mapping selection flag.<BR> 37 See the <CODE><A href="GXS_SetOBJVRamModeChar.html">GXS_SetOBJVRamModeChar</A></CODE> function.</TD> 38 </TR> 39 <TR> 40 <TD width="30%"><B><I><CODE>objMapBmp</CODE></I></B></TD> 41 <TD width="70%">Bitmap OBJ mapping selection flag.<BR> 42 See the <CODE><A href="GXS_SetOBJVRamModeBmp.html">GXS_SetOBJVRamModeBmp</A></CODE> function.</TD> 43 </TR> 44 <TR> 45 <TD width="30%"><I><B><CODE>blankScr</CODE></B></I></TD> 46 <TD width="70%">2D display forced blank setting. Normally this parameter is not used and dispMode parameter is used for ON/OFF control of the display.</TD> 47 </TR> 48 <TR> 49 <TD width="30%"><I><B><CODE>visiblePlane</CODE></B></I></TD> 50 <TD width="70%">2D display plane setting. For more information, see the <CODE>GXPlaneMask</CODE> type in the <CODE><A href="GXS_SetVisiblePlane.html">GXS_SetVisiblePlane</A></CODE> function.</TD> 51 </TR> 52 <TR> 53 <TD><B><I><CODE>visibleWnd</CODE></I></B></TD> 54 <TD>Window display setting. For more information, see the <code>GXWndMask</code> type in the <CODE><A href="GXS_SetVisibleWnd.html">GXS_SetVisibleWnd</A></CODE> function.</TD> 55 </TR> 56 <TR> 57 <TD><B><I><CODE>dispMode</CODE></I></B></TD> 58 <TD>Display mode setting. It is used by the <CODE><A href="GXS_DispOn.html">GXS_DispOn</A></CODE> and <CODE><A href="GXS_DispOff.html">GXS_DispOff</A></CODE> functions.</TD> 59 </TR> 60 <TR> 61 <TD><B><I><CODE>extObjMapChar</CODE></I></B></TD> 62 <TD>Character OBJ's VRAM capacity setting.<BR> 63 See the <CODE><A href="GXS_SetOBJVRamModeChar.html">GXS_SetOBJVRamModeChar</A></CODE> function.</TD> 64 </TR> 65 <TR> 66 <TD><B><I><CODE>hBlankObjProc</CODE></I></B></TD> 67 <TD>Sets the OBJ process during the H-Blank. For more information, see the <CODE><A href="GXS_HBlankOBJProc.html">GXS_HBlankOBJProc</A></CODE> function.</TD> 68 </TR> 69 <TR> 70 <TD><B><I><CODE>bgExtPltt</CODE></I></B></TD> 71 <TD>BG extended palette enable flag. It is set in VRAM bank setting functions, such as <CODE><A href="GX_SetBankForSubBGExtPltt.html">GX_SetBankForSubBGExtPltt</A></CODE>.</TD> 72 </TR> 73 <TR> 74 <TD><B><I><CODE>objExtPltt</CODE></I></B></TD> 75 <TD>OBJ extended palette enable flag. It is set in VRAM bank setting functions, such as <CODE><A href="GX_SetBankForSubOBJExtPltt.html">GX_SetBankForSubOBJExtPltt</A></CODE>.</TD> 76 </TR> 77 </TBODY> 78</TABLE> 79<P>The type definition of <code>GXDispCnt</code> type is shown below.</P> 80<PRE><CODE>typedef union 81{ 82 u32 raw; 83 struct { 84 u32 bgMode :3; 85 u32 _reserve1 :1; 86 u32 objMapChar :1; 87 u32 objMapBmp :2; 88 u32 blankScr :1; 89 u32 visiblePlane :5; 90 u32 visibleWnd :3; 91 u32 dispMode :1; 92 u32 _reserve2 :3; 93 u32 extObjMapChar :2; 94 u32 _reserve3 :1; 95 u32 hBlankObjProc :1; 96 u32 _reserve4 :6; 97 u32 bgExtPltt :1; 98 u32 objExtPltt :1; 99 }; 100} 101GXSDispCnt; 102 103</CODE></PRE> 104<h2>See Also</h2> 105<H2>Revision History</H2> 106<P>2004/12/24 Initial version.</P> 107 108<hr><p>CONFIDENTIAL</p></body> 109</html> 110
