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_TrySetBankForSubOBJExtPltt</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_TrySetBankForSubOBJExtPltt <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_TrySetBankForSubOBJExtPltt(GXVRamSubOBJExtPltt objExtPltt);</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">objExtPltt</font></strong></em></td>
27    <td width="87%">Specifies a VRAM bank to allocate to the sub 2D Engine's OBJ Extended palette.</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 extended palette . If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the sub 2D Engine OBJ's Extended palette. The allocation will fail if the designated VRAM bank is exclusion-locked by another library.<BR> <B>Note: </B> When the OBJ Extended palette is allocated, the 256-color OBJ uses the OBJ Extended palette. However, 16-color OBJs normally use the standard palette.
36</P>
37<TABLE border="1">
38  <TBODY>
39    <TR>
40      <TD><CODE>GX_VRAM_SUB_OBJEXTPLTT_NONE</CODE></TD>
41      <TD>A VRAM bank is not allocated to the OBJ Extended palette.</TD>
42    </TR>
43    <TR>
44      <TD><CODE>GX_VRAM_SUB_OBJEXTPLTT_0_I</CODE></TD>
45      <TD>The OBJ Extended palette is reserved. VRAM-I is allocated.</TD>
46    </TR>
47  </TBODY>
48</TABLE>
49<P>The following is the type definition for <CODE>GXVRamSubOBJExtPltt</CODE> types.</P>
50<PRE><CODE>typedef enum
51{
52    GX_VRAM_SUB_OBJEXTPLTT_NONE = 0x0000,
53    GX_VRAM_SUB_OBJEXTPLTT_0_I  = GX_VRAM_I
54}
55GXVRamSubOBJExtPltt;</CODE></PRE>
56<h2>See Also</h2>
57<P><code><A href="GX_SetBankForSubOBJExtPltt.html">GX_SetBankForSubOBJExtPltt</A>, <A href="GX_GetSizeOfSubOBJExtPltt.html">GX_GetSizeOfSubOBJExtPltt</A>, <A href="GX_GetBankForSubOBJExtPltt.html">GX_GetBankForSubOBJExtPltt</A>, <A href="GX_ResetBankForSubOBJExtPltt.html">GX_ResetBankForSubOBJExtPltt</A>, <A href="GX_DisableBankForSubOBJExtPltt.html">GX_DisableBankForSubOBJExtPltt</A></code></P>
58<H2>Revision History</H2>
59<P>2005/02/15 Initial version.</P>
60<hr><p>CONFIDENTIAL</p></body>
61</html>
62