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>G2_SetOBJAttr</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">G2_SetOBJAttr <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/g2_oam.h&gt;<BR>
21void G2_SetOBJAttr(
22    <A href="../gx/GXOamAttr.html">GXOamAttr</A> * oam,
23    int x,
24    int y,
25    int priority,
26    GXOamMode mode,
27    BOOL mosaic,
28    GXOamEffect effect,
29    GXOamShape shape,
30    GXOamColorMode color,
31    int charName,
32    int cParam,
33    int rsParam
34);</CODE></PRE></dd>
35</dl><h2>Arguments</h2>
36<TABLE border="1" width="100%">
37  <TBODY>
38    <TR>
39      <TD width="149"><em><strong><font face="Courier New">oam</font></strong></em></TD>
40      <TD width="706">Pointer to the location storing the OAM data</TD>
41    </TR>
42    <TR>
43      <TD><em><strong><font face="Courier New">x</font></strong></em></TD>
44      <TD>X coordinate</TD>
45    </TR>
46    <TR>
47      <TD><em><strong><font face="Courier New">y</font></strong></em></TD>
48      <TD>Y coordinate</TD>
49    </TR>
50    <TR>
51      <TD><em><strong><font face="Courier New">priority</font></strong></em></TD>
52      <TD>Display priority (0-3)</TD>
53    </TR>
54    <TR>
55      <TD><em><strong><font face="Courier New">mode</font></strong></em></TD>
56      <TD>OBJ mode</TD>
57    </TR>
58    <TR>
59      <TD><em><strong><font face="Courier New">mosaic</font></strong></em></TD>
60      <TD>Mosaic enable/disable</TD>
61    </TR>
62    <TR>
63      <TD><em><strong><font face="Courier New">effect</font></strong></em></TD>
64      <TD>Specify effect type</TD>
65    </TR>
66    <TR>
67      <TD><em><strong><font face="Courier New">shape</font></strong></em></TD>
68      <TD>Shape of OBJ</TD>
69    </TR>
70    <TR>
71      <TD><em><strong><font face="Courier New">color</font></strong></em></TD>
72      <TD>Color mode (can only be specified in 16-color mode when mode is set to bitmap OBJ)</TD>
73    </TR>
74    <TR>
75      <TD><em><strong><font face="Courier New">charName</font></strong></em></TD>
76      <TD>Name of the first character (must be an even number when in 2-dimensional mapping mode and 256-color mode)</TD>
77    </TR>
78    <TR>
79      <TD><em><strong><font face="Courier New">cParam</font></strong></em></TD>
80      <TD>Color parameter (is <CODE>a</CODE> when <B><I>mode</I></B> is set to bitmap OBJ; in all other cases, color palette is <CODE>No</CODE>)</TD>
81    </TR>
82    <TR>
83      <TD><em><strong><font face="Courier New">rsParam</font></strong></em></TD>
84      <TD>Affine transformation parameter index (valid only when the effect is affine or affine double display)</TD>
85    </TR>
86  </TBODY>
87</TABLE>
88<h2>Return Values</h2>
89<p>None.</p>
90<H2>Description</H2>
91<P>This function sets OBJ attributes in a batch. This function can set all the bits for OBJ attributes 0, 1, and 2.
92</P>
93<TABLE border="1">
94  <TBODY>
95    <TR>
96      <TD width="30%"><CODE>GX_OAM_MODE_NORMAL</CODE></TD>
97      <TD>Normal OBJ</TD>
98    </TR>
99    <TR>
100      <TD><CODE>GX_OAM_MODE_XLU</CODE></TD>
101      <TD>Translucent OBJ</TD>
102    </TR>
103    <TR>
104      <TD><CODE>GX_OAM_MODE_OBJWND</CODE></TD>
105      <TD>OBJ window</TD>
106    </TR>
107    <TR>
108      <TD><CODE>GX_OAM_MODE_BITMAPOBJ</CODE></TD>
109      <TD>Bitmap OBJ</TD>
110    </TR>
111  </TBODY>
112</TABLE>
113<P></P>
114<TABLE border="1">
115  <TBODY>
116    <TR>
117      <TD width="30%"><CODE>GX_OAM_EFFECT_NONE</CODE></TD>
118      <TD>No effects</TD>
119    </TR>
120    <TR>
121      <TD><CODE>GX_OAM_EFFECT_FLIP_H</CODE></TD>
122      <TD>H flip</TD>
123    </TR>
124    <TR>
125      <TD><CODE>GX_OAM_EFFECT_FLIP_V</CODE></TD>
126      <TD>V flip</TD>
127    </TR>
128    <TR>
129      <TD><CODE>GX_OAM_EFFECT_FLIP_HV</CODE></TD>
130      <TD>HV flip</TD>
131    </TR>
132    <TR>
133      <TD><CODE>GX_OAM_EFFECT_AFFINE</CODE></TD>
134      <TD>Affine</TD>
135    </TR>
136    <TR>
137      <TD><CODE>GX_OAM_EFFECT_NODISPLAY</CODE></TD>
138      <TD>Hide</TD>
139    </TR>
140    <TR>
141      <TD><CODE>GX_OAM_EFFECT_AFFINE_DOUBLE</CODE></TD>
142      <TD>Affine (Double-size display)</TD>
143    </TR>
144  </TBODY>
145</TABLE>
146<P></P>
147<TABLE border="1">
148  <TBODY>
149    <TR>
150      <TD width="30%"><CODE>GX_OAM_SHAPE_8x8</CODE></TD>
151      <TD><CODE>8x8</CODE> pixels</TD>
152    </TR>
153    <TR>
154      <TD><CODE>GX_OAM_SHAPE_16x16</CODE></TD>
155      <TD><CODE>16x16</CODE> pixels</TD>
156    </TR>
157    <TR>
158      <TD><CODE>GX_OAM_SHAPE_32x32</CODE></TD>
159      <TD><CODE>32x32</CODE> pixels</TD>
160    </TR>
161    <TR>
162      <TD><CODE>GX_OAM_SHAPE_64x64</CODE></TD>
163      <TD><CODE>64x64</CODE> pixels</TD>
164    </TR>
165    <TR>
166      <TD><CODE>GX_OAM_SHAPE_16x8</CODE></TD>
167      <TD><CODE>16x8</CODE> pixels</TD>
168    </TR>
169    <TR>
170      <TD><CODE>GX_OAM_SHAPE_32x8</CODE></TD>
171      <TD><CODE>32x8</CODE> pixels</TD>
172    </TR>
173    <TR>
174      <TD><CODE>GX_OAM_SHAPE_32x16</CODE></TD>
175      <TD><CODE>32x16</CODE> pixels</TD>
176    </TR>
177    <TR>
178      <TD><CODE>GX_OAM_SHAPE_64x32</CODE></TD>
179      <TD><CODE>64x32</CODE> pixels</TD>
180    </TR>
181    <TR>
182      <TD><CODE>GX_OAM_SHAPE_8x16</CODE></TD>
183      <TD><CODE>8x16</CODE> pixels</TD>
184    </TR>
185    <TR>
186      <TD><CODE>GX_OAM_SHAPE_8x32</CODE></TD>
187      <TD><CODE>8x32</CODE> pixels</TD>
188    </TR>
189    <TR>
190      <TD><CODE>GX_OAM_SHAPE_16x32</CODE></TD>
191      <TD><CODE>16x32</CODE> pixels</TD>
192    </TR>
193    <TR>
194      <TD><CODE>GX_OAM_SHAPE_32x64</CODE></TD>
195      <TD><CODE>32x64</CODE> pixels</TD>
196    </TR>
197  </TBODY>
198</TABLE>
199<P></P>
200<TABLE border="1">
201  <TBODY>
202    <TR>
203      <TD width="30%"><CODE>GX_OAM_COLORMODE_16</CODE></TD>
204      <TD>16-color mode</TD>
205    </TR>
206    <TR>
207      <TD><CODE>GX_OAM_COLORMODE_256</CODE></TD>
208      <TD>256-color mode</TD>
209    </TR>
210  </TBODY>
211</TABLE>
212<P>Below are the matrix format type definitions used in the argument.</P>
213<PRE><CODE>typedef enum
214{
215    GX_OAM_MODE_NORMAL = 0,
216    GX_OAM_MODE_XLU = 1,
217    GX_OAM_MODE_OBJWND = 2,
218    GX_OAM_MODE_BITMAPOBJ = 3
219}
220GXOamMode;
221
222typedef enum
223{
224    GX_OAM_EFFECT_NONE =
225        (0 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_HF_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_VF_SHIFT),
226    GX_OAM_EFFECT_FLIP_H =
227        (0 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_HF_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_VF_SHIFT),
228    GX_OAM_EFFECT_FLIP_V =
229        (0 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_HF_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_VF_SHIFT),
230    GX_OAM_EFFECT_FLIP_HV =
231        (0 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_HF_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_VF_SHIFT),
232    GX_OAM_EFFECT_AFFINE = (1 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT),
233    GX_OAM_EFFECT_NODISPLAY = (2 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT),
234    GX_OAM_EFFECT_AFFINE_DOUBLE = (3 &lt;&lt; GX_OAM_ATTR01_RSENABLE_SHIFT)
235}
236GXOamEffect;
237
238typedef enum
239{
240    GX_OAM_SHAPE_8x8 = (0 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
241    GX_OAM_SHAPE_16x16 = (0 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
242    GX_OAM_SHAPE_32x32 = (0 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (2 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
243    GX_OAM_SHAPE_64x64 = (0 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (3 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
244    GX_OAM_SHAPE_16x8 = (1 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
245    GX_OAM_SHAPE_32x8 = (1 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
246    GX_OAM_SHAPE_32x16 = (1 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (2 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
247    GX_OAM_SHAPE_64x32 = (1 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (3 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
248    GX_OAM_SHAPE_8x16 = (2 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (0 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
249    GX_OAM_SHAPE_8x32 = (2 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (1 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
250    GX_OAM_SHAPE_16x32 = (2 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (2 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT),
251    GX_OAM_SHAPE_32x64 = (2 &lt;&lt; GX_OAM_ATTR01_SHAPE_SHIFT) | (3 &lt;&lt; GX_OAM_ATTR01_SIZE_SHIFT)
252}
253GXOamShape;
254
255typedef enum
256{
257    GX_OAM_COLORMODE_16 = 0,
258    GX_OAM_COLORMODE_256 = 1
259}
260GXOamColorMode;</CODE></PRE>
261
262<h2>See Also</h2>
263<P><A href="../gx/GXOamAttr.html">GXOamAttr</A></P>
264<H2>Revision History</H2>
265<P>2004/02/13 Initial version.</P>
266<UL>
267  <LI>Added to Description.
268</UL>
269<P>2004/01/19 Initial version.</P>
270<hr><p>CONFIDENTIAL</p></body>
271</html>
272