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