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>GXS_SetOBJVRamModeChar</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">GXS_SetOBJVRamModeChar <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 GXS_SetOBJVRamModeChar(GXOBJVRamModeChar mode);</CODE>
22</PRE></dd>
23</dl><h2>Arguments</h2>
24
25<table border="1" width="100%">
26
27    <tr>
28    <td width="13%"><em><strong><font face="Courier New">mode</font></strong></em></td>
29    <td width="87%">Mapping mode</td>
30  </tr>
31  </table>
32<h2>Return Values</h2>
33<p>None.</p>
34<H2>Description</H2>
35<P>This function sets OBJ-VRAM capacity for sub 2D Engine character OBJs and sets mapping mode.
36</P>
37<TABLE border="1">
38  <TBODY>
39    <TR>
40      <TD width="30%"><CODE>GX_OBJVRAMMODE_CHAR_2D</CODE></TD>
41      <TD>Selects 2D mapping mode.</TD>
42    </TR>
43    <TR>
44      <TD width="30%"><CODE>GX_OBJVRAMMODE_CHAR_1D_32K</CODE></TD>
45      <TD>Sets 1D mapping mode with the first character name boundary of 32 bytes. The maximum capacity of OBJ-VRAM is 32 Kilobytes.</TD>
46    </TR>
47    <TR>
48      <TD width="30%"><CODE>GX_OBJVRAMMODE_CHAR_1D_64K</CODE></TD>
49      <TD>Sets 1D mapping mode with the first character name boundary of 64 bytes. The maximum capacity of OBJ-VRAM is 64 Kilobytes.</TD>
50    </TR>
51    <TR>
52      <TD width="30%"><CODE>GX_OBJVRAMMODE_CHAR_1D_128K</CODE></TD>
53      <TD>Sets 1D mapping mode with the first character name boundary of 128 bytes. The maximum capacity of OBJ-VRAM is 128 Kilobytes.</TD>
54    </TR>
55    <TR>
56      <TD width="30%"><CODE>GX_OBJVRAMMODE_CHAR_1D_256K</CODE></TD>
57      <TD><FONT color="#ff0000">This setting is prohibited with a sub-2D engine.</FONT></TD>
58    </TR>
59  </TBODY>
60</TABLE>
61<P>Mapping mode specifies the first character name boundary and is not related to the bank capacity of VRAM that is actually allocated.</P>
62<P>The following are <CODE>GXOBJVRamModeChar</CODE> matrix format type definitions.</P>
63<PRE><CODE>typedef enum
64{
65    GX_OBJVRAMMODE_CHAR_2D = (0 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT) | (0 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT),
66    GX_OBJVRAMMODE_CHAR_1D_32K = (1 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT) | (0 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT),
67    GX_OBJVRAMMODE_CHAR_1D_64K = (1 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT) | (1 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT),
68    GX_OBJVRAMMODE_CHAR_1D_128K = (1 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT) | (2 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT),
69    GX_OBJVRAMMODE_CHAR_1D_256K = (1 &lt;&lt; REG_GX_DISPCNT_OBJMAP_SHIFT) | (3 &lt;&lt; REG_GX_DISPCNT_EXOBJ_SHIFT) // * prohibited setting
70}
71GXOBJVRamModeChar;</CODE></PRE>
72<h2>See Also</h2>
73<P><CODE><A href="GXS_SetOBJVRamModeBmp.html">GXS_SetOBJVRamModeBmp</A>, <A href="GX_GetOBJVRamModeChar.html">GXS_GetOBJVRamModeChar</A></CODE></P>
74<H2>Revision History</H2>
75<P>2004/08/03 Initial version.</P>
76<UL>
77<LI>Revised the descriptions of 1-dimensional mapping. </LI>
78</UL>
79<P>2004/02/09 Initial version.</P>
80
81
82<hr><p>CONFIDENTIAL</p></body>
83</html>
84