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_SetOBJVRamModeBmp</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GX_SetOBJVRamModeBmp <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<PRE>
20<CODE>#include &lt;nitro/gx/gx.h&gt;<BR>
21void GX_SetOBJVRamModeBmp(GXOBJVRamModeBmp mode);</CODE></PRE></dd>
22</dl><h2>Arguments</h2>
23
24<table border="1" width="100%">
25
26    <tr>
27    <td width="13%"><em><strong><font face="Courier New">mode</font></strong></em></td>
28    <td width="87%">Mapping mode</td>
29  </tr>
30  </table>
31<h2>Return Values</h2>
32<p>None.</p>
33<H2>Description</H2>
34<P>This function sets OBJ-VRAM capacity for a bitmap OBJ, and sets mapping mode.
35</P>
36<TABLE border="1">
37  <TBODY>
38    <TR>
39      <TD width="30%"><CODE>GX_OBJVRAMMODE_BMP_2D_W128</CODE></TD>
40      <TD>Selects 2D mapping mode with 128 horizontal pixels.</TD>
41    </TR>
42    <TR>
43      <TD><CODE>GX_OBJVRAMMODE_BMP_2D_W256</CODE></TD>
44      <TD>Selects 2D mapping mode with 256 horizontal pixels.</TD>
45    </TR>
46    <TR>
47      <TD><CODE>GX_OBJVRAMMODE_BMP_1D_128K</CODE></TD>
48      <TD>Sets 1D mapping mode with OBJ-VRAM capacity of 128 Kilobytes. The first character name boundary is 128 bytes.</TD>
49    </TR>
50    <TR>
51      <TD><CODE>GX_OBJVRAMMODE_BMP_1D_256K</CODE></TD>
52      <TD>Sets 1D mapping mode with OBJ-VRAM capacity of 256 Kilobytes. The first character name boundary is 256 bytes.</TD>
53    </TR>
54  </TBODY>
55</TABLE>
56<P>The following shows <CODE>GXOBJVRamModeBmp</CODE> format type definitions:</P>
57<PRE><CODE>typedef enum
58{
59    GX_OBJVRAMMODE_BMP_2D_W128_32K = (0 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
60    GX_OBJVRAMMODE_BMP_2D_W256_32K = (1 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
61    GX_OBJVRAMMODE_BMP_1D_128K = (2 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (0 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT + 2),
62    GX_OBJVRAMMODE_BMP_1D_256K = (2 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT + 1) | (1 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT + 2)
63}
64GXOBJVRamModeBmp;
65
66// OBSOLETE: These macros will be removed in the future release.
67#define GX_OBJVRAMMODE_BMP_2D_W128_32K GX_OBJVRAMMODE_BMP_2D_W128
68#define GX_OBJVRAMMODE_BMP_2D_W256_32K GX_OBJVRAMMODE_BMP_2D_W256</CODE></PRE>
69<h2>See Also</h2>
70<P><CODE><A href="GX_SetOBJVRamModeChar.html">GX_SetOBJVRamModeChar</A>, <A href="GX_GetOBJVRamModeBmp.html">GX_GetOBJVRamModeBmp</A></CODE></P>
71<H2>Revision History</H2>
72<P>2004/02/09 Initial version.</P>
73<UL>
74  <LI>Changed the enum type values <CODE>GX_OBJVRAMMODE_BMP_2D_W128_32K</CODE> and <CODE>GX_OBJVRAMMODE_BMP_2D_W256_32K</CODE> to <CODE>GX_OBJVRAMMODE_BMP_2D_W128</CODE> and <CODE>GX_OBJVRAMMODE_BMP_2D_W256</CODE>
75</UL>
76<P>2004/01/19 Initial version.</P>
77<hr><p>CONFIDENTIAL</p></body>
78</html>
79