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_SetBankForOBJ</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetBankForOBJ <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_SetBankForOBJ(GXVRamOBJ obj);</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">obj</font></strong></em></td>
27    <td width="87%">Specifies a VRAM bank to allocate to the main 2D Engine's OBJ</td>
28  </tr>
29  </table>
30<h2>Return Values</h2>
31<p>None.</p>
32<H2>Description</H2>
33<P>This function allocates the specified VRAM bank to the Main 2D Engine's OBJ. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the Main 2D Engine OBJ.
34</P>
35<TABLE border="1">
36  <TBODY>
37    <TR>
38      <TD><CODE>GX_VRAM_OBJ_NONE</CODE></TD>
39      <TD>VRAM is not allocated to OBJ.</TD>
40    </TR>
41    <TR>
42      <TD><CODE>GX_VRAM_OBJ_16_F</CODE></TD>
43      <TD>16 kilobytes of OBJ are reserved. VRAM-F is allocated.</TD>
44    </TR>
45    <TR>
46      <TD><CODE>GX_VRAM_OBJ_16_G</CODE></TD>
47      <TD>16 kilobytes of OBJ are reserved. VRAM-G is allocated.</TD>
48    </TR>
49    <TR>
50      <TD><CODE>GX_VRAM_OBJ_32_FG</CODE></TD>
51      <TD>32 kilobytes of OBJ are reserved. VRAM-F and -G are allocated.</TD>
52    </TR>
53    <TR>
54      <TD><CODE>GX_VRAM_OBJ_64_E</CODE></TD>
55      <TD>64 kilobytes of OBJ are reserved. VRAM-E is allocated.</TD>
56    </TR>
57    <TR>
58      <TD><CODE>GX_VRAM_OBJ_80_EF</CODE></TD>
59      <TD>80 kilobytes of OBJ are reserved. VRAM-E and -F are allocated.</TD>
60    </TR>
61    <TR>
62      <TD><CODE>GX_VRAM_OBJ_80_EG</CODE></TD>
63      <TD>80 kilobytes of OBJ are reserved. VRAM-E and -G are allocated.</TD>
64    </TR>
65    <TR>
66      <TD><CODE>GX_VRAM_OBJ_96_EFG</CODE></TD>
67      <TD>96 kilobytes of OBJ are reserved. VRAM-E, -F, and -G are allocated.</TD>
68    </TR>
69    <TR>
70      <TD><CODE>GX_VRAM_OBJ_128_A</CODE></TD>
71      <TD>128 kilobytes of OBJ are reserved. VRAM-A is allocated.</TD>
72    </TR>
73    <TR>
74      <TD><CODE>GX_VRAM_OBJ_128_B</CODE></TD>
75      <TD>128 kilobytes of OBJ are reserved. VRAM-B is allocated.</TD>
76    </TR>
77    <TR>
78      <TD><CODE>GX_VRAM_OBJ_256_AB</CODE></TD>
79      <TD>256 kilobytes of OBJ are reserved. VRAM-A and -B are allocated.</TD>
80    </TR>
81  </TBODY>
82</TABLE>
83<P><BR> The following is the type definition for <CODE>GXVRamOBJ</CODE> types.</P>
84<PRE><CODE>typedef enum
85{
86    GX_VRAM_OBJ_NONE   = 0x0000,
87    GX_VRAM_OBJ_16_F   = GX_VRAM_F,                      // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_F_SIZE
88    GX_VRAM_OBJ_16_G   = GX_VRAM_G,                      // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_G_SIZE
89    GX_VRAM_OBJ_32_FG  = GX_VRAM_F | GX_VRAM_G,          // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_F_SIZE + HW_VRAM_G_SIZE
90    GX_VRAM_OBJ_64_E   = GX_VRAM_E,                      // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_E_SIZE
91    GX_VRAM_OBJ_80_EF  = GX_VRAM_E | GX_VRAM_F,          // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_E_SIZE + HW_VRAM_F_SIZE
92    GX_VRAM_OBJ_80_EG  = GX_VRAM_E | GX_VRAM_G,          // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_E_SIZE + HW_VRAM_G_SIZE
93    GX_VRAM_OBJ_96_EFG = GX_VRAM_E | GX_VRAM_F | GX_VRAM_G, // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_E_SIZE + HW_VRAM_F_SIZE + HW_VRAM_G_SIZE
94    GX_VRAM_OBJ_128_A  = GX_VRAM_A,                      // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_A_SIZE
95    GX_VRAM_OBJ_128_B  = GX_VRAM_B,                      // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_B_SIZE
96    GX_VRAM_OBJ_256_AB = GX_VRAM_A | GX_VRAM_B           // ARM9: HW_OBJ_VRAM  --&gt;   HW_OBJ_VRAM + HW_VRAM_A_SIZE + HW_VRAM_B_SIZE
97}
98GXVRamOBJ;</CODE></PRE>
99<h2>See Also</h2>
100<P><A href="GX_GetBankForOBJ.html"><code>GX_GetBankForOBJ</code></A>, <A href="GX_ResetBankForOBJ.html"><code>GX_ResetBankForOBJ</code></A>, <A href="GX_DisableBankForOBJ.html"><code>GX_DisableBankForOBJ</code></A>, <a href="GX_GetSizeOfOBJ.html"><code>GX_GetSizeOfOBJ</code></a></P>
101<H2>Revision History</H2>
102<P>2004/01/19 Initial version.</P>
103<hr><p>CONFIDENTIAL</p></body>
104</html>
105