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_TrySetBankForClearImage</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_TrySetBankForClearImage <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>BOOL GX_TrySetBankForClearImage(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>
32Returns TRUE if the VRAM bank is allocated normally. Returns FALSE if the VRAM bank to be allocated is locked by another library.
33</p>
34<H2>Description</H2>
35<P>Attempts to allocate a designated VRAM bank to ClearImage. 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. The allocation will fail if the designated VRAM bank is exclusion-locked by another library.
36</P>
37<TABLE border="1">
38  <TBODY>
39    <TR>
40      <TD><CODE>GX_VRAM_CLEARIMAGE_NONE</CODE></TD>
41      <TD>Did not allocate VRAM bank to Clear Image.</TD>
42    </TR>
43    <TR>
44      <TD><CODE>GX_VRAM_CLEARIMAGE_256_AB</CODE></TD>
45      <TD><code>VRAM-A</code> and <code>B</code> allocated to Clear Image.</TD>
46    </TR>
47    <TR>
48      <TD><CODE>GX_VRAM_CLEARIMAGE_256_CD</CODE></TD>
49      <TD><code>VRAM-C</code> and <code>D</code> allocated to Clear Image.</TD>
50    </TR>
51    <TR>
52      <TD><CODE>GX_VRAM_CLEARDEPTH_128_A</CODE></TD>
53      <TD><code>VRAM-A</code> is allocated to Clear Depth Image.
54      <br /> Texture Image Slot <code>2</code> is disabled.</TD>
55    </TR>
56    <TR>
57      <TD><CODE>GX_VRAM_CLEARDEPTH_128_B</CODE></TD>
58      <TD><code>VRAM-B</code> is allocate to Clear Depth Image.<br />
59      <br /> Texture Image Slot <code>2</code> is disabled.</TD>
60    </TR>
61    <TR>
62      <TD><CODE>GX_VRAM_CLEARDEPTH_128_C</CODE></TD>
63      <TD><code>VRAM-C</code> is allocated to Clear Depth Image.<br /><br /> Texture Image Slot <code>2</code> is disabled.</TD>
64    </TR>
65    <TR>
66      <TD><CODE>GX_VRAM_CLEARDEPTH_128_D</CODE></TD>
67      <TD><code>VRAM-D</code> is allocated to Clear Depth Image.<br /><br /> Texture Image Slot <code>2</code> is disabled.</TD>
68    </TR>
69  </TBODY>
70</TABLE>
71<P>The following describes the type definition for <code>GXVRamClearImage</code> format.</P>
72<PRE><CODE>typedef enum
73{
74    GX_VRAM_CLEARIMAGE_NONE = 0x0000,
75    GX_VRAM_CLEARIMAGE_256_AB = GX_VRAM_A | GX_VRAM_B,  // TextureImageSlot 23
76    GX_VRAM_CLEARIMAGE_256_CD = GX_VRAM_C | GX_VRAM_D,  // TextureImageSlot 23
77    GX_VRAM_CLEARDEPTH_128_A  = GX_VRAM_A,
78    GX_VRAM_CLEARDEPTH_128_B  = GX_VRAM_B,
79    GX_VRAM_CLEARDEPTH_128_C  = GX_VRAM_C,
80    GX_VRAM_CLEARDEPTH_128_D  = GX_VRAM_D
81}
82GXVRamClearImage;</code></PRE>
83<h2>See Also</h2>
84<P><code><A href="GX_SetBankForClearImage.html">GX_SetBankForClearImage</A>, <A href="GX_GetBankForClearImage.html">GX_GetBankForClearImage</A>, <A href="GX_ResetBankForClearImage.html">GX_ResetBankForClearImage</A>, <A href="GX_DisableBankForClearImage.html">GX_DisableBankForClearImage</A>, <A href="GX_GetSizeOfClearImage.html">GX_GetSizeOfClearImage</A></code></P>
85<H2>Revision History</H2>
86<P>2005/02/15 Initial version.</P>
87<hr><p>CONFIDENTIAL</p></body>
88</html>
89