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>G2*_GetWnd0InsidePlane</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">G2*_GetWnd0InsidePlane <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<PRE>
20<CODE>#include &lt;nitro/gx/g2.h&gt;
21
22GXWndPlane G2_GetWnd0InsidePlane( void );
23GXWndPlane G2S_GetWnd0InsidePlane( void );</CODE></PRE>
24  </dd>
25</dl><h2>Arguments</h2>
26<P>None.</P>
27<h2>Return Values</h2>
28<p>Information for the plane being displayed in the window.</p>
29<H2>Description</H2>
30<P>Gets the settings for the plane that is displayed inside Window 0 and the existence of color effects using the <code>GXWndPlane</code> structure.<BR> Use the <CODE>G2_GetWnd0InsidePlane</CODE> function to get the settings for the main 2D engine and the <CODE>G2S_GetWnd0InsidePlane</CODE> function to get the settings for the sub 2D engine.<BR><BR><BR> The <code>GXWndPlane</code> structure that gets returned includes the following information:<BR>
31</P>
32<TABLE border="1">
33  <TBODY>
34    <TR>
35      <TD width="30%"><I><B><CODE>planeMask</CODE></B></I></TD>
36      <TD>Information about the settings for the plane that is being displayed in the window. See the <CODE><A href="G2_SetWnd0InsidePlane.html">G2_SetWnd0InsidePlane</A></CODE> function for more details.</TD>
37    </TR>
38    <TR>
39      <TD width="30%"><I><B><CODE>effect</CODE></B></I></TD>
40      <TD>The setting for the existence of color effects inside the window.</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44<P>Following is the type definition for type <code>GXWndPlane</code>:</P>
45<PRE><CODE>typedef struct
46{
47        u8      planeMask       :5;
48        u8      effect          :1;
49        u8      _reserve        :2;
50}
51GXWndPlane;
52
53</CODE></PRE>
54<h2>See Also</h2>
55<P><A href="G2_SetWnd0InsidePlane.html">G2_SetWnd0InsidePlane</A><A href="G2_SetWndOutsidePlane.html"></A></P>
56<H2>Revision History</H2>
57<P>2004/12/24 Initial version.</P>
58<hr><p>CONFIDENTIAL</p></body>
59</html>
60