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>GX_GetVisiblePlane</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX*_GetVisiblePlane <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 &lt;nitro/gx/gx.h&gt;</CODE><BR>
20  <BR>
21  <CODE>int GX_GetVisiblePlane( void );</CODE><BR>
22  <CODE>int GXS_GetVisiblePlane( void );</CODE></dd>
23</dl><h2>Arguments</h2>
24<P>None.</P>
25<h2>Return Values</h2>
26<p>Returns the display plane with the logical sum of <CODE>GXPlaneMask</CODE> type.</p>
27<H2>Description</H2>
28<P>Obtains the set of visible planes. The function returns the logical sum of <CODE>GXPlaneMask</CODE> values. The <CODE>GX_GetVisiblePlane</CODE> function gets the settings for the main graphics engine, and the <CODE>GXS_GetVisiblePlane</CODE> function gets the settings for the sub graphics engine.<BR>
29</P>
30<TABLE border="1">
31  <TBODY>
32    <TR>
33      <TD width="30%"><CODE>GX_PLANEMASK_NONE</CODE></TD>
34      <TD width="70%">Indicates that nothing is visible.</TD>
35    </TR>
36    <TR>
37      <TD><CODE>GX_PLANEMASK_BG0</CODE></TD>
38      <TD>Specifies BG0.</TD>
39    </TR>
40    <TR>
41      <TD><CODE>GX_PLANEMASK_BG1</CODE></TD>
42      <TD>Specifies BG1.</TD>
43    </TR>
44    <TR>
45      <TD><CODE>GX_PLANEMASK_BG2</CODE></TD>
46      <TD>Specifies BG2.</TD>
47    </TR>
48    <TR>
49      <TD><CODE>GX_PLANEMASK_BG3</CODE></TD>
50      <TD>Specifies BG3.</TD>
51    </TR>
52    <TR>
53      <TD><CODE>GX_PLANEMASK_OBJ</CODE></TD>
54      <TD>Specifies OBJs.</TD>
55    </TR>
56  </TBODY>
57</TABLE>
58<P>The type definition of <CODE>GXPlaneMask</CODE> type is shown below.</P>
59<PRE><CODE>typedef enum
60{
61    GX_PLANEMASK_NONE = 0x00,
62    GX_PLANEMASK_BG0 = 0x01,
63    GX_PLANEMASK_BG1 = 0x02,
64    GX_PLANEMASK_BG2 = 0x04,
65    GX_PLANEMASK_BG3 = 0x08,
66    GX_PLANEMASK_OBJ = 0x10
67}
68GXPlaneMask;</CODE></PRE>
69<h2>See Also</h2>
70<P><CODE><A href="GX_GetVisibleWnd.html">GX_GetVisibleWnd</A>, <A href="GX_SetVisiblePlane.html">GX_SetVisiblePlane</A>, <A href="GXS_SetVisiblePlane.html">GXS_SetVisiblePlane</A></CODE></P>
71<H2>Revision History</H2>
72<P>2004/12/24 Initial version.</P>
73<hr><p>CONFIDENTIAL</p></body>
74</html>
75