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