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