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_SetBankForBG</title> 9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13 14<h1 align="left">GX_SetBankForBG <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 <nitro/gx/gx_vramcnt.h></CODE><BR> 20 <BR> 21 <CODE>void GX_SetBankForBG(GXVRamBG 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> </font></strong></em></td> 27 <td width="87%">Specifies a VRAM bank to allocate to the BG of the main 2D Engine.</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. Allocates that VRAM bank to the BG of the main 2D engine if the designated VRAM bank is disabled or if it is allocated to LCDC. <B>Note:</B> VRAM combinations other than those defined below cannot be allocated to successive addresses, so they cannot be configured with this function. You may be able to configure some VRAM combinations with the <CODE><A href="GX_SetBankForBGEx.html">GX_SetBankForBGEx</A></CODE> function. See this function's description for more information. 34</P> 35<TABLE border="1"> 36 <TBODY> 37 <TR> 38 <TD><CODE>GX_VRAM_BG_NONE</CODE></TD> 39 <TD>The VRAM bank is not allocated to BG.</TD> 40 </TR> 41 <TR> 42 <TD><CODE>GX_VRAM_BG_16_F</CODE></TD> 43 <TD>16KB is reserved in BG. VRAM-F is allocated.</TD> 44 </TR> 45 <TR> 46 <TD><CODE>GX_VRAM_BG_16_G</CODE></TD> 47 <TD>16KB is reserved in BG. VRAM-G is allocated.</TD> 48 </TR> 49 <TR> 50 <TD><CODE>GX_VRAM_BG_32_FG</CODE></TD> 51 <TD>32KB is reserved in BG. VRAM-F and -G are allocated.</TD> 52 </TR> 53 <TR> 54 <TD><CODE>GX_VRAM_BG_64_E</CODE></TD> 55 <TD>64KB is reserved in BG. VRAM-E is allocated.</TD> 56 </TR> 57 <TR> 58 <TD><CODE>GX_VRAM_BG_80_EF</CODE></TD> 59 <TD>80KB is reserved in BG. VRAM-E and -F are allocated.</TD> 60 </TR> 61 <TR> 62 <TD><CODE>GX_VRAM_BG_96_EFG</CODE></TD> 63 <TD>96KB is reserved in BG. VRAM-E, -F, and -G are allocated.</TD> 64 </TR> 65 <TR> 66 <TD><CODE>GX_VRAM_BG_128_A</CODE></TD> 67 <TD>128KB is reserved in BG. VRAM-A is allocated.</TD> 68 </TR> 69 <TR> 70 <TD><CODE>GX_VRAM_BG_128_B</CODE></TD> 71 <TD>128KB is reserved in BG. VRAM-B is allocated.</TD> 72 </TR> 73 <TR> 74 <TD><CODE>GX_VRAM_BG_128_C</CODE></TD> 75 <TD>128KB is reserved in BG. VRAM-C is allocated.</TD> 76 </TR> 77 <TR> 78 <TD><CODE>GX_VRAM_BG_128_D</CODE></TD> 79 <TD>128KB is reserved in BG. VRAM-D is allocated.</TD> 80 </TR> 81 <TR> 82 <TD><CODE>GX_VRAM_BG_256_AB</CODE></TD> 83 <TD>256KB is reserved in BG. VRAM-A and -B are allocated.</TD> 84 </TR> 85 <TR> 86 <TD><CODE>GX_VRAM_BG_256_BC</CODE></TD> 87 <TD>256KB is reserved in BG. VRAM-B and -C are allocated.</TD> 88 </TR> 89 <TR> 90 <TD><CODE>GX_VRAM_BG_256_CD</CODE></TD> 91 <TD>256KB is reserved in BG. VRAM-C and -D are allocated.</TD> 92 </TR> 93 <TR> 94 <TD><CODE>GX_VRAM_BG_384_ABC</CODE></TD> 95 <TD>384KB is reserved in BG. VRAM-A, -B, and -C are allocated.</TD> 96 </TR> 97 <TR> 98 <TD><CODE>GX_VRAM_BG_384_BCD</CODE></TD> 99 <TD>384KB is reserved in BG. VRAM-B, -C, and -D are allocated.</TD> 100 </TR> 101 <TR> 102 <TD><CODE>GX_VRAM_BG_512_ABCD</CODE></TD> 103 <TD>512KB is reserved in BG. VRAM-A, -B, -C, and -D are allocated.</TD> 104 </TR> 105 <TR> 106 <TD><CODE>GX_VRAM_BG_80_EG</CODE></TD> 107 <TD>80KB is reserved in BG. VRAM-E and -G are allocated.</TD> 108 </TR> 109 <TR> 110 <TD><CODE>GX_VRAM_BG_256_AC</CODE></TD> 111 <TD>256KB is reserved in BG. VRAM-A and -C are allocated.</TD> 112 </TR> 113 <TR> 114 <TD><CODE>GX_VRAM_BG_256_AD</CODE></TD> 115 <TD>256KB is reserved in BG. VRAM-A and -D are allocated.</TD> 116 </TR> 117 <TR> 118 <TD><CODE>GX_VRAM_BG_256_BD</CODE></TD> 119 <TD>256KB is reserved in BG. VRAM-B and -D are allocated.</TD> 120 </TR> 121 <TR> 122 <TD><CODE>GX_VRAM_BG_384_ABD</CODE></TD> 123 <TD>384KB is reserved in BG. VRAM-A, -B, and -D are allocated.</TD> 124 </TR> 125 <TR> 126 <TD><CODE>GX_VRAM_BG_384_ACD</CODE></TD> 127 <TD>384KB is reserved in BG. VRAM-A, -C, and -D are allocated.</TD> 128 </TR> 129 </TBODY> 130</TABLE> 131<P><BR> The following is the type definition for <CODE>GXVRamBG</CODE> types:</P> 132<PRE><CODE>typedef enum 133{ 134 GX_VRAM_BG_NONE = 0x0000, 135 GX_VRAM_BG_16_F = GX_VRAM_F, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_F_SIZE 136 GX_VRAM_BG_16_G = GX_VRAM_G, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_G_SIZE 137 GX_VRAM_BG_32_FG = GX_VRAM_F | GX_VRAM_G, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_F_SIZE + HW_VRAM_G_SIZE 138 GX_VRAM_BG_64_E = GX_VRAM_E, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_E_SIZE 139 GX_VRAM_BG_80_EF = GX_VRAM_E | GX_VRAM_F, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_E_SIZE + HW_VRAM_F_SIZE 140 GX_VRAM_BG_96_EFG = GX_VRAM_E | GX_VRAM_F | GX_VRAM_G, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_E_SIZE + HW_VRAM_F_SIZE + HW_VRAM_G_SIZE 141 GX_VRAM_BG_128_A = GX_VRAM_A, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE 142 GX_VRAM_BG_128_B = GX_VRAM_B, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_B_SIZE 143 GX_VRAM_BG_128_C = GX_VRAM_C, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_C_SIZE 144 GX_VRAM_BG_128_D = GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_D_SIZE 145 GX_VRAM_BG_256_AB = GX_VRAM_A | GX_VRAM_B, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_B_SIZE 146 GX_VRAM_BG_256_BC = GX_VRAM_B | GX_VRAM_C, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_B_SIZE + HW_VRAM_C_SIZE 147 GX_VRAM_BG_256_CD = GX_VRAM_C | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_C_SIZE + HW_VRAM_D_SIZE 148 GX_VRAM_BG_384_ABC = GX_VRAM_A | GX_VRAM_B | GX_VRAM_C, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_B_SIZE + HW_VRAM_C_SIZE 149 GX_VRAM_BG_384_BCD = GX_VRAM_B | GX_VRAM_C | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_B_SIZE + HW_VRAM_C_SIZE + HW_VRAM_D_SIZE 150 GX_VRAM_BG_512_ABCD = GX_VRAM_A | GX_VRAM_B | GX_VRAM_C | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_B_SIZE + HW_VRAM_C_SIZE + HW_VRAM_D_SIZE 151 152 // discontinuous on LCDC memory 153 GX_VRAM_BG_80_EG = GX_VRAM_E | GX_VRAM_G, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_E_SIZE + HW_VRAM_G_SIZE 154 GX_VRAM_BG_256_AC = GX_VRAM_A | GX_VRAM_C, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_C_SIZE 155 GX_VRAM_BG_256_AD = GX_VRAM_A | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_D_SIZE 156 GX_VRAM_BG_256_BD = GX_VRAM_B | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_B_SIZE + HW_VRAM_D_SIZE 157 GX_VRAM_BG_384_ABD = GX_VRAM_A | GX_VRAM_B | GX_VRAM_D, // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_B_SIZE + HW_VRAM_D_SIZE 158 GX_VRAM_BG_384_ACD = GX_VRAM_A | GX_VRAM_C | GX_VRAM_D // ARM9: HW_BG_VRAM --> HW_BG_VRAM + HW_VRAM_A_SIZE + HW_VRAM_C_SIZE + HW_VRAM_D_SIZE 159} 160GXVRamBG;</CODE></PRE> 161<h2>See Also</h2> 162<P><A href="GX_GetBankForBG.html"><code>GX_GetBankForBG</code></A>, <A href="GX_ResetBankForBG.html"><code>GX_ResetBankForBG</code></A>, <A href="GX_DisableBankForBG.html"><code>GX_DisableBankForBG</code></A>, <A href="GX_GetSizeOfBG.html"><code>GX_GetSizeOfBG</code></A></P> 163<H2>Revision History</H2> 164<P>2004/01/19 Initial version.</P> 165<hr><p>CONFIDENTIAL</p></body> 166</html> 167
