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_SetBankForSubBG</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetBankForSubBG <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_SetBankForSubBG(GXVRamSubBG bg);</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>bg</code></strong></em>&nbsp;&nbsp;</font></strong></em></td>
27    <td width="87%">Specifies a VRAM bank to allocate to the sub 2D Engine's BG</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 sub 2D Engine's BG. If the specified VRAM bank is either disabled or allocated to LCDC, that VRAM bank is allocated to the sub 2D Engine BG.
34</P>
35<TABLE border="1">
36  <TBODY>
37    <TR>
38      <TD><CODE>GX_VRAM_SUB_BG_NONE</CODE></TD>
39      <TD>VRAM bank is not allocated to BG.</TD>
40    </TR>
41    <TR>
42      <TD><CODE>GX_VRAM_SUB_BG_128_C</CODE></TD>
43      <TD>128 KB are reserved in BG. VRAM-C is allocated.</TD>
44    </TR>
45    <TR>
46      <TD><CODE>GX_VRAM_SUB_BG_32_H</CODE></TD>
47      <TD>32 KB are reserved in BG. VRAM-H is allocated.</TD>
48    </TR>
49    <TR>
50      <TD><CODE>GX_VRAM_SUB_BG_48_HI</CODE></TD>
51      <TD>48 KB are reserved in BG. VRAM-H and -I are allocated.</TD>
52    </TR>
53  </TBODY>
54</TABLE>
55<P>The following is the type definition for <CODE>GXVRamSubBG</CODE> types.</P>
56<PRE><CODE>typedef enum
57{
58    GX_VRAM_SUB_BG_NONE = 0x0000,
59    GX_VRAM_SUB_BG_128_C = GX_VRAM_C,
60    GX_VRAM_SUB_BG_32_H = GX_VRAM_H,
61    GX_VRAM_SUB_BG_48_HI = GX_VRAM_H | GX_VRAM_I
62}
63GXVRamSubBG;</PRE>
64<h2>See Also</h2>
65<P><A href="GX_GetBankForSubBG.html"><code>GX_GetBankForSubBG</code></A>, <A href="GX_ResetBankForSubBG.html"><code>GX_ResetBankForSubBG</code></A>, <A href="GX_DisableBankForSubBG.html"><code>GX_DisableBankForSubBG</code></A>, <a href="GX_GetSizeOfSubBG.html"><code>GX_GetSizeOfSubBG</code></a></P>
66<H2>Revision History</H2>
67<P>2004/02/09 Initial version.</P>
68<hr><p>CONFIDENTIAL</p></body>
69</html>
70