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_TrySetBankForLCDC</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_TrySetBankForLCDC <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_TrySetBankForLCDC(int lcdc);</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"><em><strong><code>lcdc</code></strong></em>&nbsp;&nbsp;</font></strong></em></td>
27    <td width="87%">Specifies a VRAM bank to allocate to LCDC</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 VRAM bank to LCDC. If the specified VRAM bank is disabled, this allocates the VRAM bank to LCDC. The logical OR of <code>GXVRamLCDC</code> values is used as the argument. 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_LCDC_NONE</CODE></TD>
41      <TD>The VRAM bank is not allocated to LCDC.</TD>
42    </TR>
43    <TR>
44      <TD><CODE>GX_VRAM_LCDC_A</CODE></TD>
45      <TD>VRAM-A is allocated to LCDC.</TD>
46    </TR>
47    <TR>
48      <TD><CODE>GX_VRAM_LCDC_B</CODE></TD>
49      <TD>VRAM-B is allocated to LCDC.</TD>
50    </TR>
51    <TR>
52      <TD><CODE>GX_VRAM_LCDC_C</CODE></TD>
53      <TD>VRAM-C is allocated to LCDC.</TD>
54    </TR>
55    <TR>
56      <TD><CODE>GX_VRAM_LCDC_D</CODE></TD>
57      <TD>VRAM-D is allocated to LCDC.</TD>
58    </TR>
59    <TR>
60      <TD><CODE>GX_VRAM_LCDC_E</CODE></TD>
61      <TD>VRAM-E is allocated to LCDC.</TD>
62    </TR>
63    <TR>
64      <TD><CODE>GX_VRAM_LCDC_F</CODE></TD>
65      <TD>VRAM-F is allocated to LCDC.</TD>
66    </TR>
67    <TR>
68      <TD><CODE>GX_VRAM_LCDC_G</CODE></TD>
69      <TD>VRAM-G is allocated to LCDC.</TD>
70    </TR>
71    <TR>
72      <TD><CODE>GX_VRAM_LCDC_H</CODE></TD>
73      <TD>VRAM-H is allocated to LCDC.</TD>
74    </TR>
75    <TR>
76      <TD><CODE>GX_VRAM_LCDC_I</CODE></TD>
77      <TD>VRAM-I is allocated to LCDC.</TD>
78    </TR>
79    <TR>
80      <TD><CODE>GX_VRAM_LCDC_ALL</CODE></TD>
81      <TD>All VRAM are allocated to LCDC.</TD>
82    </TR>
83  </TBODY>
84</TABLE>
85<P>The following indicates the type definition for <CODE>GXVRamLCDC</CODE> types.</P>
86<PRE><CODE>typedef enum
87{
88    GX_VRAM_LCDC_NONE = 0x0000,
89    GX_VRAM_LCDC_A = GX_VRAM_A,                    // ARM9: HW_LCDC_VRAM_A  --&gt;  HW_LCDC_VRAM_B
90    GX_VRAM_LCDC_B = GX_VRAM_B,                    // ARM9: HW_LCDC_VRAM_B  --&gt;  HW_LCDC_VRAM_C
91    GX_VRAM_LCDC_C = GX_VRAM_C,                    // ARM9: HW_LCDC_VRAM_C  --&gt;  HW_LCDC_VRAM_D
92    GX_VRAM_LCDC_D = GX_VRAM_D,                    // ARM9: HW_LCDC_VRAM_D  --&gt;  HW_LCDC_VRAM_E
93    GX_VRAM_LCDC_E = GX_VRAM_E,                    // ARM9: HW_LCDC_VRAM_E  --&gt;  HW_LCDC_VRAM_F
94    GX_VRAM_LCDC_F = GX_VRAM_F,                    // ARM9: HW_LCDC_VRAM_F  --&gt;  HW_LCDC_VRAM_G
95    GX_VRAM_LCDC_G = GX_VRAM_G,                    // ARM9: HW_LCDC_VRAM_G  --&gt;  HW_LCDC_VRAM_H
96    GX_VRAM_LCDC_H = GX_VRAM_H,                    // ARM9: HW_LCDC_VRAM_H  --&gt;  HW_LCDC_VRAM_I
97    GX_VRAM_LCDC_I = GX_VRAM_I,                    // ARM9: HW_LCDC_VRAM_I  --&gt;  HW_LCDC_VRAM_END
98    GX_VRAM_LCDC_ALL = 0x01ff                      // ARM9: HW_LCDC_VRAM_A  --&gt;  HW_LCDC_VRAM_END
99}
100GXVRamLCDC;</CODE></PRE>
101<h2>See Also</h2>
102<P><CODE><A href="GX_SetBankForLCDC.html">GX_SetBankForLCDC</A>, <A href="GX_GetBankForLCDC.html">GX_GetBankForLCDC</A>, <A href="GX_DisableBankForLCDC.html">GX_DisableBankForLCDC</A></CODE></P>
103<H2>Revision History</H2>
104<P>2005/02/15 Initial version.</P>
105<hr><p>CONFIDENTIAL</p></body>
106</html>
107