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_SetBankForClearImage</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetBankForClearImage <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_vramcnt.h&gt;</CODE><BR>
20  <BR>
21  <CODE>void GX_SetBankForClearImage(GXVRamClearImage clrImg);</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">clrImg</font></strong></em></td>
27    <td width="87%">Specify VRAM bank to allocate to Clear Image</td>
28  </tr>
29  </table>
30<h2>Return Values</h2>
31<p>None.</p>
32<H2>Description</H2>
33<P>Allocates the specified VRAM bank to Clear Image. The Clear Image Slot on the hardware is actually the same as Texture Image Slots <code>2</code> and <code>3</code>. When the specified VRAM bank is disabled or has been allocated to <code>LCDC</code>, that VRAM bank will be allocated to Clear Image. When VRAM is not allocated to Clear Color Image, all pixels are cleared with <code>0</code>. Texture Image Slot <code>2</code> cannot be used.
34</P>
35<TABLE border="1">
36  <TBODY>
37    <TR>
38      <TD><CODE>GX_VRAM_CLEARIMAGE_NONE</CODE></TD>
39      <TD>Did not allocate VRAM bank to Clear Image.</TD>
40    </TR>
41    <TR>
42      <TD><CODE>GX_VRAM_CLEARIMAGE_256_AB</CODE></TD>
43      <TD><code>VRAM-A</code> and <code>B</code> allocated to Clear Image.</TD>
44    </TR>
45    <TR>
46      <TD><CODE>GX_VRAM_CLEARIMAGE_256_CD</CODE></TD>
47      <TD><code>VRAM-C</code> and <code>D</code> allocated to Clear Image.</TD>
48    </TR>
49    <TR>
50      <TD><CODE>GX_VRAM_CLEARDEPTH_128_A</CODE></TD>
51      <TD><code>VRAM-A</code> is allocated to Clear Depth Image.
52      <br /> Texture Image Slot <code>2</code> is disabled.</TD>
53    </TR>
54    <TR>
55      <TD><CODE>GX_VRAM_CLEARDEPTH_128_B</CODE></TD>
56      <TD><code>VRAM-B</code> is allocate to Clear Depth Image.<br />
57      <br /> Texture Image Slot <code>2</code> is disabled.</TD>
58    </TR>
59    <TR>
60      <TD><CODE>GX_VRAM_CLEARDEPTH_128_C</CODE></TD>
61      <TD><code>VRAM-C</code> is allocated to Clear Depth Image.<br /><br /> Texture Image Slot <code>2</code> is disabled.</TD>
62    </TR>
63    <TR>
64      <TD><CODE>GX_VRAM_CLEARDEPTH_128_D</CODE></TD>
65      <TD><code>VRAM-D</code> is allocated to Clear Depth Image.<br /><br /> Texture Image Slot <code>2</code> is disabled.</TD>
66    </TR>
67  </TBODY>
68</TABLE>
69<P>The following describes the type definition for <code>GXVRamClearImage</code> format.</P>
70<PRE><CODE>typedef enum
71{
72    GX_VRAM_CLEARIMAGE_NONE = 0x0000,
73    GX_VRAM_CLEARIMAGE_256_AB = GX_VRAM_A | GX_VRAM_B,  // TextureImageSlot 23
74    GX_VRAM_CLEARIMAGE_256_CD = GX_VRAM_C | GX_VRAM_D,  // TextureImageSlot 23
75    GX_VRAM_CLEARDEPTH_128_A  = GX_VRAM_A,
76    GX_VRAM_CLEARDEPTH_128_B  = GX_VRAM_B,
77    GX_VRAM_CLEARDEPTH_128_C  = GX_VRAM_C,
78    GX_VRAM_CLEARDEPTH_128_D  = GX_VRAM_D
79}
80GXVRamClearImage;</code></PRE>
81<h2>See Also</h2>
82<P><a href="GX_GetBankForClearImage.html"><code>GX_GetBankForClearImage</code></a>, <a href="GX_ResetBankForClearImage.html"><code>GX_ResetBankForClearImage</code></a>, <a href="GX_DisableBankForClearImage.html"><code>GX_DisableBankForClearImage</code></a>, <a href="GX_GetSizeOfClearImage.html"><code>GX_GetSizeOfClearImage</code></a></P>
83<H2>Revision History</H2>
84<P>2004/01/19 Initial version.</P>
85<hr><p>CONFIDENTIAL</p></body>
86</html>
87