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>nn::util::FloatColor</CODE> Structure</h1>
52<h2>Syntax</h2>
53    <div class="section">
54      <pre class="definition">struct FloatColor
55{
56   f32     r;
57   f32 g;
58   f32     b;
59   f32 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>The minimum value of the color component.</td>
78          </tr>
79          <tr>
80            <td width="100">
81<span class="static_style" title="static">S</span>
82            </td>
83            <th>
84<span class="argument"><a href="../../../nn/util/FloatColor/ELEMENT_MAX.html"><CODE>ELEMENT_MAX</CODE></a></span>
85            </th>
86<td>The maximum value of the color component.</td>
87          </tr>
88          <tr>
89            <td width="100">
90<span class="static_style" title="static">S</span>
91            </td>
92            <th>
93<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_MIN.html"><CODE>ALPHA_MIN</CODE></a></span>
94            </th>
95<td>The minimum alpha value.</td>
96          </tr>
97          <tr>
98            <td width="100">
99<span class="static_style" title="static">S</span>
100            </td>
101            <th>
102<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_MAX.html"><CODE>ALPHA_MAX</CODE></a></span>
103            </th>
104<td>The maximum alpha value.</td>
105          </tr>
106          <tr>
107            <td width="100">
108<span class="static_style" title="static">S</span>
109            </td>
110            <th>
111<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_OPACITY.html"><CODE>ALPHA_OPACITY</CODE></a></span>
112            </th>
113<td>The alpha value for transparency.</td>
114          </tr>
115          <tr>
116            <td width="100">
117<span class="static_style" title="static">S</span>
118            </td>
119            <th>
120<span class="argument"><a href="../../../nn/util/FloatColor/ALPHA_TRANSPARENT.html"><CODE>ALPHA_TRANSPARENT</CODE></a></span>
121            </th>
122<td>The alpha value for transparency.</td>
123          </tr> </table>
124      </div>
125    </a> <a name="variable" id="variable">
126<h2>Member Variables</h2>
127      <div class="section">
128        <table class="members">
129          <tr>
130            <td width="100"> </td>
131            <th>
132<span class="argument">r</span>
133            </th>
134<td>The R color component.</td>
135          </tr>
136          <tr>
137            <td width="100"> </td>
138            <th>
139<span class="argument">g</span>
140            </th>
141<td>The G color component.</td>
142          </tr>
143          <tr>
144            <td width="100"> </td>
145            <th>
146<span class="argument">b</span>
147            </th>
148<td>The B color component.</td>
149          </tr>
150          <tr>
151            <td width="100"> </td>
152            <th>
153<span class="argument">a</span>
154            </th>
155<td>The A color component.</td>
156          </tr> </table>
157      </div>
158    </a> <a name="function" id="function">
159<h2>Member Functions</h2>
160      <div class="section">
161        <table class="members">
162          <tr>
163<th class="category" colspan="3">Constructors and Destructors</th>
164          </tr>
165          <tr>
166            <td width="100">  </td>
167            <th>
168<a href="../../../nn/util/FloatColor/FloatColor.html"><CODE>FloatColor</CODE></a>
169            </th>
170<td>This is the default constructor.</td>
171          </tr>
172          <tr>
173            <td width="100">  </td>
174            <th>
175<a href="../../../nn/util/FloatColor/~FloatColor.html"><CODE>~FloatColor</CODE></a>
176            </th>
177<td>Destructor.</td>
178          </tr>
179          <tr>
180<th class="category" colspan="3">Overloaded Operators</th>
181          </tr>
182          <tr>
183            <td width="100">  </td>
184            <th>
185<a href="../../../nn/util/FloatColor/operator=.html"><CODE>operator=</CODE></a>
186            </th>
187<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>
188          </tr>
189          <tr>
190            <td width="100">  </td>
191            <th>
192<a href="../../../nn/util/FloatColor/operator f32 -2a.html"><CODE>operator f32 *</CODE></a>
193            </th>
194<td>An operator for casting to an <CODE>f32</CODE> array.</td>
195          </tr>
196          <tr>
197            <td width="100">  </td>
198            <th>
199<a href="../../../nn/util/FloatColor/operator const f32 -2a.html"><CODE>operator const f32 *</CODE></a>
200            </th>
201<td>The <CODE>const</CODE> version of an operator for casting to an <CODE>f32</CODE> array.</td>
202          </tr>
203          <tr>
204            <td width="100">  </td>
205            <th>
206<a href="../../../nn/util/FloatColor/operator Color8.html"><CODE>operator Color8</CODE></a>
207            </th>
208<td>An operator for casting to an RGBA8 color.</td>
209          </tr>
210          <tr>
211            <td width="100">  </td>
212            <th>
213<a href="../../../nn/util/FloatColor/operator nn-3a-3amath-3a-3aVEC4 &amp;.html"><CODE>operator nn::math::VEC4</CODE> &amp;</a>
214            </th>
215<td>An operator for casting to a <CODE>VEC4</CODE> value.</td>
216          </tr>
217          <tr>
218            <td width="100">  </td>
219            <th>
220<a href="../../../nn/util/FloatColor/operator const nn-3a-3amath-3a-3aVEC4 &amp;.html"><CODE>operator const nn::math::VEC4</CODE> &amp;</a>
221            </th>
222<td>The <CODE>const</CODE> version of an operator for casting to a <CODE>VEC4</CODE> value.</td>
223          </tr>
224          <tr>
225            <td width="100">  </td>
226            <th>
227<a href="../../../nn/util/FloatColor/operator+.html"><CODE>operator+</CODE></a>
228            </th>
229<td>An addition operator for two colors.</td>
230          </tr>
231          <tr>
232            <td width="100">  </td>
233            <th>
234<a href="../../../nn/util/FloatColor/operator-2d.html"><CODE>operator-</CODE></a>
235            </th>
236<td>A subtraction operator for two colors.</td>
237          </tr>
238          <tr>
239            <td width="100">  </td>
240            <th>
241<a href="../../../nn/util/FloatColor/operator-2a.html"><CODE>operator *</CODE></a>
242            </th>
243<td>A multiplication operator for two colors.</td>
244          </tr>
245          <tr>
246            <td width="100">  </td>
247            <th>
248<a href="../../../nn/util/FloatColor/operator-2f.html"><CODE>operator/</CODE></a>
249            </th>
250<td>A division operator for two colors.</td>
251          </tr>
252          <tr>
253            <td width="100">  </td>
254            <th>
255<a href="../../../nn/util/FloatColor/operator+=.html"><CODE>operator+=</CODE></a>
256            </th>
257<td>A compound assignment operator for adding two colors.</td>
258          </tr>
259          <tr>
260            <td width="100">  </td>
261            <th>
262<a href="../../../nn/util/FloatColor/operator-2d=.html"><CODE>operator-=</CODE></a>
263            </th>
264<td>A compound assignment operator for subtracting two colors.</td>
265          </tr>
266          <tr>
267            <td width="100">  </td>
268            <th>
269<a href="../../../nn/util/FloatColor/operator-2a=.html"><CODE>operator*=</CODE></a>
270            </th>
271<td>A compound assignment operator for multiplying two colors.</td>
272          </tr>
273          <tr>
274            <td width="100">  </td>
275            <th>
276<a href="../../../nn/util/FloatColor/operator-2f=.html"><CODE>operator/=</CODE></a>
277            </th>
278<td>A compound assignment operator for dividing two colors.</td>
279          </tr>
280          <tr>
281            <td width="100">  </td>
282            <th>
283<a href="../../../nn/util/FloatColor/operator==.html"><CODE>operator ==</CODE></a>
284            </th>
285<td>The equality operator.</td>
286          </tr>
287          <tr>
288            <td width="100">  </td>
289            <th>
290<a href="../../../nn/util/FloatColor/operator!=.html"><CODE>operator !=</CODE></a>
291            </th>
292<td>The inequality operator.</td>
293          </tr>
294          <tr>
295<th class="category" colspan="3">Set/Get</th>
296          </tr>
297          <tr>
298            <td width="100">  </td>
299            <th>
300<a href="../../../nn/util/FloatColor/Set.html"><CODE>Set</CODE></a>
301            </th>
302<td>Sets color values.</td>
303          </tr>
304          <tr>
305            <td width="100">  </td>
306            <th>
307<a href="../../../nn/util/FloatColor/Clamp.html"><CODE>Clamp</CODE></a>
308            </th>
309<td>Clamps each component to a value between 0.0 and 1.0.</td>
310          </tr>
311          <tr>
312            <td width="100">  </td>
313            <th>
314<a href="../../../nn/util/FloatColor/ToArray.html"><CODE>ToArray</CODE></a>
315            </th>
316<td>Converts values into an array of floating-point numbers.</td>
317          </tr>
318          <tr>
319            <td width="100">  </td>
320            <th>
321<a href="../../../nn/util/FloatColor/ToPicaU32.html"><CODE>ToPicaU32</CODE></a>
322            </th>
323<td>Converts values into the PICA <CODE>u32</CODE> type.</td>
324          </tr> </table>
325      </div>
326    </a>
327<h2>Revision History</h2>
328    <div class="section">
329      <dl class="history">
330        <dt>2010/08/23</dt>
331<dd>Initial version.<br />
332        </dd>
333      </dl>
334    </div>
335  <hr><p>CONFIDENTIAL</p></body>
336</html>
337