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_SetGraphicsMode</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetGraphicsMode <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_SetGraphicsMode(GXDispMode dispMode, GXBGMode bgMode, GXBG0As bg0_2d3d);</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">dispMode</font></strong></em></td>
27    <td width="87%">Specifies the display mode: Graphics display mode, VRAM display mode, or Main Memory display mode.</td>
28  </tr>
29  <tr>
30    <td width="13%"><em><strong><font face="Courier New">bgMode</font></strong></em></td>
31    <td width="87%">Selects BG mode.</td>
32  </tr>
33    <TR>
34      <TD><em><strong><font face="Courier New">bg0_2d3d</font></strong></em></TD>
35      <TD>Selects whether to allocate BG0 to 3D.</TD>
36    </TR>
37  </table>
38<h2>Return Values</h2>
39<p>None.</p>
40<H2>Description</H2>
41<P>This function sets the display mode for the main graphics engine. If something other than graphics display mode is selected with <em><strong><code>dispMode</code></strong></em>, the values of <em><strong><code>bgMode</code></strong></em> and <em><strong><code>bg0_2d3d</code></strong></em> are used only for capturing the graphics display screen. The <em><strong><code>bgMode</code></strong></em> argument selects the BG mode. The <em><strong><code>bg0_2d3d</code></strong></em> argument specifies whether to use BG0 as a 2D or 3D screen. The values of <code>bgMode</code> and <code>bg0_2d3d</code> are only used with the capture of the graphics display screen when something other than graphics display mode is selected with <CODE>dispMode</CODE>.
42</P>
43<TABLE border="1">
44  <TBODY>
45    <TR>
46      <TD width="30%"><CODE>GX_DISPMODE_GRAPHICS</CODE></TD>
47      <TD width="70%">Display 2D/3D graphics.</TD>
48    </TR>
49    <TR>
50      <TD width="30%"><CODE>GX_DISPMODE_VRAM_A</CODE></TD>
51      <TD width="70%">VRAM display mode (display VRAM-A).</TD>
52    </TR>
53    <TR>
54      <TD width="30%"><CODE>GX_DISPMODE_VRAM_B</CODE></TD>
55      <TD width="70%">VRAM display mode (display VRAM-B).</TD>
56    </TR>
57    <TR>
58      <TD width="30%"><CODE>GX_DISPMODE_VRAM_C</CODE></TD>
59      <TD width="70%">VRAM display mode (display VRAM-C).</TD>
60    </TR>
61    <TR>
62      <TD width="30%"><CODE>GX_DISPMODE_VRAM_D</CODE></TD>
63      <TD width="70%">VRAM display mode (display VRAM-D).</TD>
64    </TR>
65    <TR>
66      <TD width="30%"><CODE>GX_DISPMODE_MMEM</CODE></TD>
67      <TD width="70%">Main memory display mode (transfer with the <A href="../../mi/dma/MI_DispMemDmaCopy.html"><CODE>MI_DispMemDmaCopy</CODE></A> function).</TD>
68    </TR>
69  </TBODY>
70</TABLE>
71<P></P>
72<TABLE border="1">
73  <TBODY>
74    <TR>
75      <TD width="30%"><CODE>GX_BGMODE_0</CODE></TD>
76      <TD width="70%">BG0=Text/3D, BG1=Text, BG2=Text, BG3=Text</TD>
77    </TR>
78    <TR>
79      <TD width="30%"><CODE>GX_BGMODE_1</CODE></TD>
80      <TD>BG0=Text/3D, BG1=Text, BG2=Text, BG3=Affine</TD>
81    </TR>
82    <TR>
83      <TD width="30%"><CODE>GX_BGMODE_2</CODE></TD>
84      <TD>BG0=Text/3D, BG1=Text, BG2=Affine, BG3=Affine</TD>
85    </TR>
86    <TR>
87      <TD width="30%"><CODE>GX_BGMODE_3</CODE></TD>
88      <TD>BG0=Text/3D, BG1=Text, BG2=Text, BG3=Affine Extended BG</TD>
89    </TR>
90    <TR>
91      <TD width="30%"><CODE>GX_BGMODE_4</CODE></TD>
92      <TD>BG0=Text/3D, BG1=Text, BG2=Affine, BG3=Affine Extended BG</TD>
93    </TR>
94    <TR>
95      <TD width="30%"><CODE>GX_BGMODE_5</CODE></TD>
96      <TD>BG0=Text/3D, BG1=Text, BG2=Affine Extended BG, BG3=Affine Extended BG</TD>
97    </TR>
98    <TR>
99      <TD width="30%"><CODE>GX_BGMODE_6</CODE></TD>
100      <TD>BG0=3D, BG1=None, BG2=Big Screen 256-color bitmap, BG3=None</TD>
101    </TR>
102  </TBODY>
103</TABLE>
104<P></P>
105<TABLE border="1">
106  <TBODY>
107    <TR>
108      <TD width="30%"><CODE>GX_BG0_AS_2D</CODE></TD>
109      <TD width="70%">BG0 displayed as text. Ignored when <CODE>GX_BGMODE_6</CODE> is selected.</TD>
110    </TR>
111    <TR>
112      <TD width="30%"><CODE>GX_BG0_AS_3D</CODE></TD>
113      <TD>BG0 displayed as 3D. Ignored when <CODE>GX_BGMODE_6</CODE> is selected.</TD>
114    </TR>
115  </TBODY>
116</TABLE>
117<P>The following is the type definition for <code>GXDispMode</code>, <code>GXBGMode</code>, and <code>GXBG0As</code> types.</P>
118<PRE><CODE>typedef enum
119{
120    GX_DISPMODE_GRAPHICS = 0x01,
121    GX_DISPMODE_VRAM_A = 0x02,
122    GX_DISPMODE_VRAM_B = 0x06,
123    GX_DISPMODE_VRAM_C = 0x0a,
124    GX_DISPMODE_VRAM_D = 0x0e,
125    GX_DISPMODE_MMEM = 0x03
126}
127GXDispMode;
128
129typedef enum
130{
131    GX_BGMODE_0 = 0,
132    GX_BGMODE_1 = 1,
133    GX_BGMODE_2 = 2,
134    GX_BGMODE_3 = 3,
135    GX_BGMODE_4 = 4,
136    GX_BGMODE_5 = 5,
137    GX_BGMODE_6 = 6
138}
139GXBGMode;
140
141typedef enum
142{
143    GX_BG0_AS_2D = 0,
144    GX_BG0_AS_3D = 1
145}
146GXBG0As;</PRE>
147<h2>See Also</h2>
148<H2>Revision History</H2>
149<P>2004/08/03</P>
150<UL>
151  <LI>The values of <CODE>bgMode</CODE> and <CODE>bg0_2d3d</CODE> are entered in the register when functions other than <CODE>GX_DISPMODE_GRAPHIC</CODE> are used.
152</UL>
153<P>2004/02/09</P>
154<UL>
155  <LI>Deleted <CODE>GX_DISPMODE_OFF</CODE>. Use the <A href="GX_DispOff.html"><CODE>GX_DispOff</CODE></A> function.
156</UL>
157<P>2004/01/19 Initial version.</P>
158<hr><p>CONFIDENTIAL</p></body>
159</html>
160