1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::util::FloatColor</title>
51  </head>
52  <body>
53<h1><CODE>nn::util::FloatColor</CODE> Structure</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">struct FloatColor
57{
58   f32     r;
59   f32 g;
60   f32     b;
61   f32 a;
62};
63</pre>
64    </div>
65<h2>Description</h2>
66    <div class="section">
67<p>Structure representing floating-point colors.</p><!-- write here --></div>
68    <a name="constant" id="constant">
69<h2>Member Constants</h2>
70      <div class="section">
71        <table class="members">
72          <tr>
73            <td width="100">
74<span class="static_style" title="static">S</span>
75            </td>
76            <th>
77<span class="argument"><a href="../../../nn/util/FloatColor/ELEMENT_MIN.html"><CODE>ELEMENT_MIN</CODE></a></span>
78            </th>
79<td>The minimum value of the color component.</td>
80          </tr>
81          <tr>
82            <td width="100">
83<span class="static_style" title="static">S</span>
84            </td>
85            <th>
86<span class="argument"><a href="../../../nn/util/FloatColor/ELEMENT_MAX.html"><CODE>ELEMENT_MAX</CODE></a></span>
87            </th>
88<td>The maximum value of the color component.</td>
89          </tr>
90          <tr>
91            <td width="100">
92<span class="static_style" title="static">S</span>
93            </td>
94            <th>
95<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_MIN.html"><CODE>ALPHA_MIN</CODE></a></span>
96            </th>
97<td>The minimum alpha value.</td>
98          </tr>
99          <tr>
100            <td width="100">
101<span class="static_style" title="static">S</span>
102            </td>
103            <th>
104<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_MAX.html"><CODE>ALPHA_MAX</CODE></a></span>
105            </th>
106<td>The maximum alpha value.</td>
107          </tr>
108          <tr>
109            <td width="100">
110<span class="static_style" title="static">S</span>
111            </td>
112            <th>
113<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_OPACITY.html"><CODE>ALPHA_OPACITY</CODE></a></span>
114            </th>
115<td>The alpha value for transparency.</td>
116          </tr>
117          <tr>
118            <td width="100">
119<span class="static_style" title="static">S</span>
120            </td>
121            <th>
122<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_TRANSPARENT.html"><CODE>ALPHA_TRANSPARENT</CODE></a></span>
123            </th>
124<td>The alpha value for transparency.</td>
125          </tr> </table>
126      </div>
127    </a> <a name="variable" id="variable">
128<h2>Member Variables</h2>
129      <div class="section">
130        <table class="members">
131          <tr>
132            <td width="100"> </td>
133            <th>
134<span class="argument">r</span>
135            </th>
136<td>The R color component.</td>
137          </tr>
138          <tr>
139            <td width="100"> </td>
140            <th>
141<span class="argument">g</span>
142            </th>
143<td>The G color component.</td>
144          </tr>
145          <tr>
146            <td width="100"> </td>
147            <th>
148<span class="argument">b</span>
149            </th>
150<td>The B color component.</td>
151          </tr>
152          <tr>
153            <td width="100"> </td>
154            <th>
155<span class="argument">a</span>
156            </th>
157<td>The A color component.</td>
158          </tr> </table>
159      </div>
160    </a> <a name="function" id="function">
161<h2>Member Functions</h2>
162      <div class="section">
163        <table class="members">
164          <tr>
165<th class="category" colspan="3">Constructors and Destructors</th>
166          </tr>
167          <tr>
168            <td width="100">  </td>
169            <th>
170<a href="../../../nn/util/FloatColor/FloatColor.html"><CODE>FloatColor</CODE></a>
171            </th>
172<td>This is the default constructor.</td>
173          </tr>
174          <tr>
175            <td width="100">  </td>
176            <th>
177<a href="../../../nn/util/FloatColor/~FloatColor.html"><CODE>~FloatColor</CODE></a>
178            </th>
179<td>Destructor.</td>
180          </tr>
181          <tr>
182<th class="category" colspan="3">Overloaded Operators</th>
183          </tr>
184          <tr>
185            <td width="100">  </td>
186            <th>
187<a href="../../../nn/util/FloatColor/operator=.html"><CODE>operator=</CODE></a>
188            </th>
189<td>An assignment operator that sets a <a href="../../../nn/util/FloatColor/Overview.html"><CODE>FloatColor</CODE></a> value equal to an RGBA8 color.</td>
190          </tr>
191          <tr>
192            <td width="100">  </td>
193            <th>
194<a href="../../../nn/util/FloatColor/operator f32 -2a.html"><CODE>operator f32 *</CODE></a>
195            </th>
196<td>An operator for casting to an <CODE>f32</CODE> array.</td>
197          </tr>
198          <tr>
199            <td width="100">  </td>
200            <th>
201<a href="../../../nn/util/FloatColor/operator const f32 -2a.html"><CODE>operator const f32 *</CODE></a>
202            </th>
203<td>The <CODE>const</CODE> version of an operator for casting to an <CODE>f32</CODE> array.</td>
204          </tr>
205          <tr>
206            <td width="100">  </td>
207            <th>
208<a href="../../../nn/util/FloatColor/operator Color8.html"><CODE>operator Color8</CODE></a>
209            </th>
210<td>An operator for casting to an RGBA8 color.</td>
211          </tr>
212          <tr>
213            <td width="100">  </td>
214            <th>
215<a href="../../../nn/util/FloatColor/operator nn-3a-3amath-3a-3aVEC4 &amp;.html"><CODE>operator nn::math::VEC4</CODE> &amp;</a>
216            </th>
217<td>An operator for casting to a <CODE>VEC4</CODE> value.</td>
218          </tr>
219          <tr>
220            <td width="100">  </td>
221            <th>
222<a href="../../../nn/util/FloatColor/operator const nn-3a-3amath-3a-3aVEC4 &amp;.html"><CODE>operator const nn::math::VEC4</CODE> &amp;</a>
223            </th>
224<td>The <CODE>const</CODE> version of an operator for casting to a <CODE>VEC4</CODE> value.</td>
225          </tr>
226          <tr>
227            <td width="100">  </td>
228            <th>
229<a href="../../../nn/util/FloatColor/operator+.html"><CODE>operator+</CODE></a>
230            </th>
231<td>An addition operator for two colors.</td>
232          </tr>
233          <tr>
234            <td width="100">  </td>
235            <th>
236<a href="../../../nn/util/FloatColor/operator-2d.html"><CODE>operator-</CODE></a>
237            </th>
238<td>A subtraction operator for two colors.</td>
239          </tr>
240          <tr>
241            <td width="100">  </td>
242            <th>
243<a href="../../../nn/util/FloatColor/operator-2a.html"><CODE>operator *</CODE></a>
244            </th>
245<td>A multiplication operator for two colors.</td>
246          </tr>
247          <tr>
248            <td width="100">  </td>
249            <th>
250<a href="../../../nn/util/FloatColor/operator-2f.html"><CODE>operator/</CODE></a>
251            </th>
252<td>A division operator for two colors.</td>
253          </tr>
254          <tr>
255            <td width="100">  </td>
256            <th>
257<a href="../../../nn/util/FloatColor/operator+=.html"><CODE>operator+=</CODE></a>
258            </th>
259<td>A compound assignment operator for adding two colors.</td>
260          </tr>
261          <tr>
262            <td width="100">  </td>
263            <th>
264<a href="../../../nn/util/FloatColor/operator-2d=.html"><CODE>operator-=</CODE></a>
265            </th>
266<td>A compound assignment operator for subtracting two colors.</td>
267          </tr>
268          <tr>
269            <td width="100">  </td>
270            <th>
271<a href="../../../nn/util/FloatColor/operator-2a=.html"><CODE>operator*=</CODE></a>
272            </th>
273<td>A compound assignment operator for multiplying two colors.</td>
274          </tr>
275          <tr>
276            <td width="100">  </td>
277            <th>
278<a href="../../../nn/util/FloatColor/operator-2f=.html"><CODE>operator/=</CODE></a>
279            </th>
280<td>A compound assignment operator for dividing two colors.</td>
281          </tr>
282          <tr>
283            <td width="100">  </td>
284            <th>
285<a href="../../../nn/util/FloatColor/operator==.html"><CODE>operator ==</CODE></a>
286            </th>
287<td>The equality operator.</td>
288          </tr>
289          <tr>
290            <td width="100">  </td>
291            <th>
292<a href="../../../nn/util/FloatColor/operator!=.html"><CODE>operator !=</CODE></a>
293            </th>
294<td>The inequality operator.</td>
295          </tr>
296          <tr>
297<th class="category" colspan="3">Set/Get</th>
298          </tr>
299          <tr>
300            <td width="100">  </td>
301            <th>
302<a href="../../../nn/util/FloatColor/Set.html"><CODE>Set</CODE></a>
303            </th>
304<td>Sets color values.</td>
305          </tr>
306          <tr>
307            <td width="100">  </td>
308            <th>
309<a href="../../../nn/util/FloatColor/Clamp.html"><CODE>Clamp</CODE></a>
310            </th>
311<td>Clamps each component to a value between 0.0 and 1.0.</td>
312          </tr>
313          <tr>
314            <td width="100">  </td>
315            <th>
316<a href="../../../nn/util/FloatColor/ToArray.html"><CODE>ToArray</CODE></a>
317            </th>
318<td>Converts values into an array of floating-point numbers.</td>
319          </tr>
320          <tr>
321            <td width="100">  </td>
322            <th>
323<a href="../../../nn/util/FloatColor/ToPicaU32.html"><CODE>ToPicaU32</CODE></a>
324            </th>
325<td>Converts values into the PICA <CODE>u32</CODE> type.</td>
326          </tr> </table>
327      </div>
328    </a>
329<h2>Revision History</h2>
330    <div class="section">
331      <dl class="history">
332        <dt>2010/08/23</dt>
333<dd>Initial version.<br />
334        </dd>
335      </dl>
336    </div>
337  <hr><p>CONFIDENTIAL</p></body>
338</html>