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_SetBankForBGExtPltt</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetBankForBGExtPltt <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_SetBankForBGExtPltt(GXVRamBGExtPltt bgExtPltt);</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">bgExtPltt</font></strong></em></td>
27    <td width="87%">Specifies a VRAM bank to allocate to the main 2D Engine's BG Extended palette</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 BG Extended palette. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the Main 2D Engine BG Extended palette.<BR> <b>Note:</B>&nbsp; When the VRAM bank is allocated to the BG Extended palette, the palette information of the BG Extended palette is referenced when 256 colors are specified as the color mode for text BG or 256x16 palette BG is selected. At all other times, the standard palette is referenced.
34</P>
35<TABLE border="1">
36  <TBODY>
37    <TR>
38      <TD><CODE>GX_VRAM_BGEXTPLTT_NONE</CODE></TD>
39      <TD>The VRAM bank is not allocated to the BG Extended palette.</TD>
40    </TR>
41    <TR>
42      <TD><CODE>GX_VRAM_BGEXTPLTT_01_F</CODE></TD>
43      <TD>Slots 0 and 1 of the BG Extended palette are reserved. VRAM-F is allocated.</TD>
44    </TR>
45    <TR>
46      <TD><CODE>GX_VRAM_BGEXTPLTT_23_G</CODE></TD>
47      <TD>Slots 2 and 3 of the BG Extended palette are reserved. VRAM-G is allocated.</TD>
48    </TR>
49    <TR>
50      <TD><CODE>GX_VRAM_BGEXTPLTT_0123_E</CODE></TD>
51      <TD>Slots 0, 1, 2, and 3 of the BG Extended palette are reserved. VRAM-E is allocated.</TD>
52    </TR>
53    <TR>
54      <TD><CODE>GX_VRAM_BGEXTPLTT_0123_FG</CODE></TD>
55      <TD>Slots 0, 1, 2, and 3 of the BG Extended palette are reserved. VRAM-F and -G are allocated.</TD>
56    </TR>
57  </TBODY>
58</TABLE>
59<P><BR> The following is the type definition for <CODE>GXVRamBGExtPltt</CODE> types.</P>
60<PRE><CODE>typedef enum
61{
62    GX_VRAM_BGEXTPLTT_NONE    = 0x0000,
63    GX_VRAM_BGEXTPLTT_01_F    = GX_VRAM_F,              // BGExtPltt 0-1 &lt;--- Caution
64    GX_VRAM_BGEXTPLTT_23_G    = GX_VRAM_G,              // BGExtPltt 2-3 &lt;--- Caution // BGCNT
65    GX_VRAM_BGEXTPLTT_0123_E  = GX_VRAM_E,              // BGExtPltt 0-3
66    GX_VRAM_BGEXTPLTT_0123_FG = GX_VRAM_F | GX_VRAM_G   // BGExtPltt 0-1,2-3
67}
68GXVRamBGExtPltt;</CODE></PRE>
69<h2>See Also</h2>
70<P><A href="GX_GetBankForBGExtPltt.html"><code>GX_GetBankForBGExtPltt</code></A>, <A href="GX_ResetBankForBGExtPltt.html"><code>GX_ResetBankForBGExtPltt</code></A>, <A href="GX_DisableBankForBGExtPltt.html"><code>GX_DisableBankForBGExtPltt</code></A>, <a href="GX_GetSizeOfBGExtPltt.html"><code>GX_GetSizeOfBGExtPltt</code></a></P>
71<H2>Revision History</H2>
72<P>2004/02/09</P>
73<UL>
74  <LI>Added a note.
75</UL>
76<P>2004/01/19 Initial version.</P>
77<hr><p>CONFIDENTIAL</p></body>
78</html>
79