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_TrySetBankForSubOBJ</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_TrySetBankForSubOBJ <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_TrySetBankForSubOBJ(GXVRamSubOBJ 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 sub 2D Engine's OBJ</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 the sub 2D engine OBJ. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the sub 2D Engine's OBJ. 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_SUB_OBJ_NONE</CODE></TD>
41      <TD>VRAM is not allocated to OBJ.</TD>
42    </TR>
43    <TR>
44      <TD><CODE>GX_VRAM_SUB_OBJ_128_D</CODE></TD>
45      <TD>128 kilobytes of OBJ are reserved. VRAM-D is allocated.</TD>
46    </TR>
47    <TR>
48      <TD><CODE>GX_VRAM_SUB_OBJ_16_I</CODE></TD>
49      <TD>16 kilobytes of OBJ are reserved. VRAM-I is allocated.</TD>
50    </TR>
51  </TBODY>
52</TABLE>
53<P>The following is the type definition for <CODE>GXVRamSubOBJ</CODE> types.</P>
54<PRE><CODE>typedef enum
55{
56    GX_VRAM_SUB_OBJ_NONE  = 0x0000,
57    GX_VRAM_SUB_OBJ_128_D = GX_VRAM_D,
58    GX_VRAM_SUB_OBJ_16_I  = GX_VRAM_I
59}
60GXVRamSubOBJ;</PRE>
61<h2>See Also</h2>
62<P><code><A href="GX_SetBankForSubOBJ.html">GX_SetBankForSubOBJ</A>, <A href="GX_GetBankForSubOBJ.html">GX_GetBankForSubOBJ</A>, <A href="GX_ResetBankForSubOBJ.html">GX_ResetBankForSubOBJ</A>, <A href="GX_DisableBankForSubOBJ.html">GX_DisableBankForSubOBJ</A>, <A href="GX_GetSizeOfSubOBJ.html">GX_GetSizeOfSubOBJ</A></code></P>
63<H2>Revision History</H2>
64<P>2005/02/15 Initial version.</P>
65<hr><p>CONFIDENTIAL</p></body>
66</html>
67