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_SetVisiblePlane</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetVisiblePlane <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>void GX_SetVisiblePlane(int plane);</CODE></dd>
22</dl><h2>Arguments</h2>
23
24<table border="1" width="100%">
25  <tr>
26    <td width="13%"><em><strong><font face="Courier New">plane</font></strong></em></td>
27    <td width="87%">Specifies display plane with logical sum of <code>GXPlaneMask</code> types</td>
28  </tr>
29  </table>
30<h2>Return Values</h2>
31<p>None.</p>
32<H2>Description</H2>
33<P>This function selects a plane to display. The argument is the logical sum of the <code>GXPlaneMask</code> type values.
34</P>
35<TABLE border="1">
36  <TBODY>
37    <TR>
38      <TD width="30%"><CODE>GX_PLANEMASK_NONE</CODE></TD>
39      <TD width="70%">Indicates that nothing is visible.</TD>
40    </TR>
41    <TR>
42      <TD><CODE>GX_PLANEMASK_BG0</CODE></TD>
43      <TD>Specifies BG0.</TD>
44    </TR>
45    <TR>
46      <TD><CODE>GX_PLANEMASK_BG1</CODE></TD>
47      <TD>Specifies BG1.</TD>
48    </TR>
49    <TR>
50      <TD><CODE>GX_PLANEMASK_BG2</CODE></TD>
51      <TD>Specifies BG2.</TD>
52    </TR>
53    <TR>
54      <TD><CODE>GX_PLANEMASK_BG3</CODE></TD>
55      <TD>Specifies BG3.</TD>
56    </TR>
57    <TR>
58      <TD><CODE>GX_PLANEMASK_OBJ</CODE></TD>
59      <TD>Specifies OBJs.</TD>
60    </TR>
61  </TBODY>
62</TABLE>
63<P>The type definition of <CODE>GXPlaneMask</CODE> type is shown below.</P>
64<PRE><CODE>typedef enum
65{
66    GX_PLANEMASK_NONE = 0x00,
67    GX_PLANEMASK_BG0 = 0x01,
68    GX_PLANEMASK_BG1 = 0x02,
69    GX_PLANEMASK_BG2 = 0x04,
70    GX_PLANEMASK_BG3 = 0x08,
71    GX_PLANEMASK_OBJ = 0x10
72}
73GXPlaneMask;</CODE></PRE>
74<h2>See Also</h2>
75<P><CODE><A href="GX_SetVisibleWnd.html">GX_SetVisibleWnd</A>, <A href="GX_GetVisiblePlane.html">GX_GetVisiblePlane</A></CODE></P>
76<H2>Revision History</H2>
77<P>2004/01/19 Initial version.</P>
78<hr><p>CONFIDENTIAL</p></body>
79</html>
80