source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ColourValue.html @ 692

Revision 692, 56.5 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::ColourValue class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ColourValue Class Reference</h1>Class representing colour. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1ColourValue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea0">ColourValue</a> (float red=1.0f, float green=1.0f, float blue=1.0f, float alpha=1.0f)</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea1">operator==</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rhs) const </td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea2">operator!=</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rhs) const </td></tr>
23
24<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a68">RGBA</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea3">getAsRGBA</a> (void) const </td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves colour as RGBA.  <a href="#Ogre_1_1ColourValuea3"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a69">ARGB</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea4">getAsARGB</a> (void) const </td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves colour as ARGB.  <a href="#Ogre_1_1ColourValuea4"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a71">BGRA</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea5">getAsBGRA</a> (void) const </td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves colour as BGRA.  <a href="#Ogre_1_1ColourValuea5"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a70">ABGR</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea6">getAsABGR</a> (void) const </td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves colours as ABGR.  <a href="#Ogre_1_1ColourValuea6"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea7">setAsRGBA</a> (const <a class="el" href="namespaceOgre.html#a68">RGBA</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo4">val</a>)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets colour as RGBA.  <a href="#Ogre_1_1ColourValuea7"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea8">setAsARGB</a> (const <a class="el" href="namespaceOgre.html#a69">ARGB</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo4">val</a>)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets colour as ARGB.  <a href="#Ogre_1_1ColourValuea8"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea9">setAsBGRA</a> (const <a class="el" href="namespaceOgre.html#a71">BGRA</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo4">val</a>)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets colour as BGRA.  <a href="#Ogre_1_1ColourValuea9"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea10">setAsABGR</a> (const <a class="el" href="namespaceOgre.html#a70">ABGR</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo4">val</a>)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets colour as ABGR.  <a href="#Ogre_1_1ColourValuea10"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea11">saturate</a> (void)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clamps colour value to the range [0, 1].  <a href="#Ogre_1_1ColourValuea11"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea12">saturateCopy</a> (void) const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy.  <a href="#Ogre_1_1ColourValuea12"></a><br><br></td></tr>
54<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea13">operator+</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rkVector) const </td></tr>
55
56<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea14">operator-</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rkVector) const </td></tr>
57
58<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea15">operator *</a> (const float fScalar) const </td></tr>
59
60<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea16">operator *</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rhs) const </td></tr>
61
62<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea17">operator/</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rhs) const </td></tr>
63
64<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea18">operator/</a> (const float fScalar) const </td></tr>
65
66<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea19">operator+=</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rkVector)</td></tr>
67
68<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea20">operator-=</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rkVector)</td></tr>
69
70<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea21">operator *=</a> (const float fScalar)</td></tr>
71
72<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea22">operator/=</a> (const float fScalar)</td></tr>
73
74<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuea23">setHSB</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> hue, <a class="el" href="namespaceOgre.html#a465">Real</a> saturation, <a class="el" href="namespaceOgre.html#a465">Real</a> brightness)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a colour value from Hue, Saturation and Brightness.  <a href="#Ogre_1_1ColourValuea23"></a><br><br></td></tr>
77<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
78<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues0">ZERO</a></td></tr>
79
80<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues1">Black</a></td></tr>
81
82<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues2">White</a></td></tr>
83
84<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues3">Red</a></td></tr>
85
86<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues4">Green</a></td></tr>
87
88<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues5">Blue</a></td></tr>
89
90<tr><td colspan=2><br><h2>Friends</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuen0">operator *</a> (const float fScalar, const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;rkVector)</td></tr>
92
93<tr><td class="memItemLeft" nowrap align=right valign=top>_OgreExport friend std::ostream &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValuen1">operator&lt;&lt;</a> (std::ostream &amp;o, const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;c)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for writing to a stream.  <a href="#Ogre_1_1ColourValuen1"></a><br><br></td></tr>
96</table>
97<hr><a name="_details"></a><h2>Detailed Description</h2>
98Class representing colour.
99<p>
100<dl compact><dt><b>Remarks:</b></dt><dd>Colour is represented as 4 components, each of which is a floating-point value from 0.0 to 1.0. </dd></dl>
101<dl compact><dt><b></b></dt><dd>The 3 'normal' colour components are red, green and blue, a higher number indicating greater amounts of that component in the colour. The forth component is the 'alpha' value, which represents transparency. In this case, 0.0 is completely transparent and 1.0 is fully opaque. </dd></dl>
102
103<p>
104
105<p>
106Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00048">48</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
107<a class="anchor" name="Ogre_1_1ColourValuea0" doxytag="Ogre::ColourValue::ColourValue" ></a><p>
108<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
109  <tr>
110    <td class="mdRow">
111      <table cellpadding="0" cellspacing="0" border="0">
112        <tr>
113          <td class="md" nowrap valign="top"> Ogre::ColourValue::ColourValue </td>
114          <td class="md" valign="top">(&nbsp;</td>
115          <td class="md" nowrap valign="top">float&nbsp;</td>
116          <td class="mdname" nowrap> <em>red</em> = 1.0f, </td>
117        </tr>
118        <tr>
119          <td class="md" nowrap align="right"></td>
120          <td></td>
121          <td class="md" nowrap>float&nbsp;</td>
122          <td class="mdname" nowrap> <em>green</em> = 1.0f, </td>
123        </tr>
124        <tr>
125          <td class="md" nowrap align="right"></td>
126          <td></td>
127          <td class="md" nowrap>float&nbsp;</td>
128          <td class="mdname" nowrap> <em>blue</em> = 1.0f, </td>
129        </tr>
130        <tr>
131          <td class="md" nowrap align="right"></td>
132          <td></td>
133          <td class="md" nowrap>float&nbsp;</td>
134          <td class="mdname" nowrap> <em>alpha</em> = 1.0f</td>
135        </tr>
136        <tr>
137          <td></td>
138          <td class="md">)&nbsp;</td>
139          <td class="md" colspan="2"><code> [explicit]</code></td>
140        </tr>
141
142      </table>
143    </td>
144  </tr>
145</table>
146<table cellspacing=5 cellpadding=0 border=0>
147  <tr>
148    <td>
149      &nbsp;
150    </td>
151    <td>
152
153<p>
154
155<p>
156Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00058">58</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
157  </tr>
158</table>
159<hr><h2>Member Function Documentation</h2>
160<a class="anchor" name="Ogre_1_1ColourValuea6" doxytag="Ogre::ColourValue::getAsABGR" ></a><p>
161<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
162  <tr>
163    <td class="mdRow">
164      <table cellpadding="0" cellspacing="0" border="0">
165        <tr>
166          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a70">ABGR</a> Ogre::ColourValue::getAsABGR </td>
167          <td class="md" valign="top">(&nbsp;</td>
168          <td class="md" nowrap valign="top">void&nbsp;</td>
169          <td class="mdname1" valign="top" nowrap>          </td>
170          <td class="md" valign="top">&nbsp;)&nbsp;</td>
171          <td class="md" nowrap> const</td>
172        </tr>
173
174      </table>
175    </td>
176  </tr>
177</table>
178<table cellspacing=5 cellpadding=0 border=0>
179  <tr>
180    <td>
181      &nbsp;
182    </td>
183    <td>
184
185<p>
186Retrieves colours as ABGR.
187<p>
188    </td>
189  </tr>
190</table>
191<a class="anchor" name="Ogre_1_1ColourValuea4" doxytag="Ogre::ColourValue::getAsARGB" ></a><p>
192<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a69">ARGB</a> Ogre::ColourValue::getAsARGB </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="md" nowrap valign="top">void&nbsp;</td>
200          <td class="mdname1" valign="top" nowrap>          </td>
201          <td class="md" valign="top">&nbsp;)&nbsp;</td>
202          <td class="md" nowrap> const</td>
203        </tr>
204
205      </table>
206    </td>
207  </tr>
208</table>
209<table cellspacing=5 cellpadding=0 border=0>
210  <tr>
211    <td>
212      &nbsp;
213    </td>
214    <td>
215
216<p>
217Retrieves colour as ARGB.
218<p>
219    </td>
220  </tr>
221</table>
222<a class="anchor" name="Ogre_1_1ColourValuea5" doxytag="Ogre::ColourValue::getAsBGRA" ></a><p>
223<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
224  <tr>
225    <td class="mdRow">
226      <table cellpadding="0" cellspacing="0" border="0">
227        <tr>
228          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a71">BGRA</a> Ogre::ColourValue::getAsBGRA </td>
229          <td class="md" valign="top">(&nbsp;</td>
230          <td class="md" nowrap valign="top">void&nbsp;</td>
231          <td class="mdname1" valign="top" nowrap>          </td>
232          <td class="md" valign="top">&nbsp;)&nbsp;</td>
233          <td class="md" nowrap> const</td>
234        </tr>
235
236      </table>
237    </td>
238  </tr>
239</table>
240<table cellspacing=5 cellpadding=0 border=0>
241  <tr>
242    <td>
243      &nbsp;
244    </td>
245    <td>
246
247<p>
248Retrieves colour as BGRA.
249<p>
250    </td>
251  </tr>
252</table>
253<a class="anchor" name="Ogre_1_1ColourValuea3" doxytag="Ogre::ColourValue::getAsRGBA" ></a><p>
254<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
255  <tr>
256    <td class="mdRow">
257      <table cellpadding="0" cellspacing="0" border="0">
258        <tr>
259          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a68">RGBA</a> Ogre::ColourValue::getAsRGBA </td>
260          <td class="md" valign="top">(&nbsp;</td>
261          <td class="md" nowrap valign="top">void&nbsp;</td>
262          <td class="mdname1" valign="top" nowrap>          </td>
263          <td class="md" valign="top">&nbsp;)&nbsp;</td>
264          <td class="md" nowrap> const</td>
265        </tr>
266
267      </table>
268    </td>
269  </tr>
270</table>
271<table cellspacing=5 cellpadding=0 border=0>
272  <tr>
273    <td>
274      &nbsp;
275    </td>
276    <td>
277
278<p>
279Retrieves colour as RGBA.
280<p>
281    </td>
282  </tr>
283</table>
284<a class="anchor" name="Ogre_1_1ColourValuea16" doxytag="Ogre::ColourValue::operator *" ></a><p>
285<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
286  <tr>
287    <td class="mdRow">
288      <table cellpadding="0" cellspacing="0" border="0">
289        <tr>
290          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator * </td>
291          <td class="md" valign="top">(&nbsp;</td>
292          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
293          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
294          <td class="md" valign="top">&nbsp;)&nbsp;</td>
295          <td class="md" nowrap> const</td>
296        </tr>
297
298      </table>
299    </td>
300  </tr>
301</table>
302<table cellspacing=5 cellpadding=0 border=0>
303  <tr>
304    <td>
305      &nbsp;
306    </td>
307    <td>
308
309<p>
310
311<p>
312Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00176">176</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
313<p>
314References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
315  </tr>
316</table>
317<a class="anchor" name="Ogre_1_1ColourValuea15" doxytag="Ogre::ColourValue::operator *" ></a><p>
318<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
319  <tr>
320    <td class="mdRow">
321      <table cellpadding="0" cellspacing="0" border="0">
322        <tr>
323          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator * </td>
324          <td class="md" valign="top">(&nbsp;</td>
325          <td class="md" nowrap valign="top">const float&nbsp;</td>
326          <td class="mdname1" valign="top" nowrap> <em>fScalar</em>          </td>
327          <td class="md" valign="top">&nbsp;)&nbsp;</td>
328          <td class="md" nowrap> const</td>
329        </tr>
330
331      </table>
332    </td>
333  </tr>
334</table>
335<table cellspacing=5 cellpadding=0 border=0>
336  <tr>
337    <td>
338      &nbsp;
339    </td>
340    <td>
341
342<p>
343
344<p>
345Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00164">164</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
346<p>
347References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
348  </tr>
349</table>
350<a class="anchor" name="Ogre_1_1ColourValuea21" doxytag="Ogre::ColourValue::operator *=" ></a><p>
351<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
352  <tr>
353    <td class="mdRow">
354      <table cellpadding="0" cellspacing="0" border="0">
355        <tr>
356          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; Ogre::ColourValue::operator *= </td>
357          <td class="md" valign="top">(&nbsp;</td>
358          <td class="md" nowrap valign="top">const float&nbsp;</td>
359          <td class="mdname1" valign="top" nowrap> <em>fScalar</em>          </td>
360          <td class="md" valign="top">&nbsp;)&nbsp;</td>
361          <td class="md" nowrap></td>
362        </tr>
363
364      </table>
365    </td>
366  </tr>
367</table>
368<table cellspacing=5 cellpadding=0 border=0>
369  <tr>
370    <td>
371      &nbsp;
372    </td>
373    <td>
374
375<p>
376
377<p>
378Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00248">248</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
379  </tr>
380</table>
381<a class="anchor" name="Ogre_1_1ColourValuea2" doxytag="Ogre::ColourValue::operator!=" ></a><p>
382<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
383  <tr>
384    <td class="mdRow">
385      <table cellpadding="0" cellspacing="0" border="0">
386        <tr>
387          <td class="md" nowrap valign="top"> bool Ogre::ColourValue::operator!= </td>
388          <td class="md" valign="top">(&nbsp;</td>
389          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
390          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
391          <td class="md" valign="top">&nbsp;)&nbsp;</td>
392          <td class="md" nowrap> const</td>
393        </tr>
394
395      </table>
396    </td>
397  </tr>
398</table>
399<table cellspacing=5 cellpadding=0 border=0>
400  <tr>
401    <td>
402      &nbsp;
403    </td>
404    <td>
405
406<p>
407    </td>
408  </tr>
409</table>
410<a class="anchor" name="Ogre_1_1ColourValuea13" doxytag="Ogre::ColourValue::operator+" ></a><p>
411<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
412  <tr>
413    <td class="mdRow">
414      <table cellpadding="0" cellspacing="0" border="0">
415        <tr>
416          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator+ </td>
417          <td class="md" valign="top">(&nbsp;</td>
418          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
419          <td class="mdname1" valign="top" nowrap> <em>rkVector</em>          </td>
420          <td class="md" valign="top">&nbsp;)&nbsp;</td>
421          <td class="md" nowrap> const</td>
422        </tr>
423
424      </table>
425    </td>
426  </tr>
427</table>
428<table cellspacing=5 cellpadding=0 border=0>
429  <tr>
430    <td>
431      &nbsp;
432    </td>
433    <td>
434
435<p>
436
437<p>
438Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00140">140</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
439<p>
440References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
441  </tr>
442</table>
443<a class="anchor" name="Ogre_1_1ColourValuea19" doxytag="Ogre::ColourValue::operator+=" ></a><p>
444<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
445  <tr>
446    <td class="mdRow">
447      <table cellpadding="0" cellspacing="0" border="0">
448        <tr>
449          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; Ogre::ColourValue::operator+= </td>
450          <td class="md" valign="top">(&nbsp;</td>
451          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
452          <td class="mdname1" valign="top" nowrap> <em>rkVector</em>          </td>
453          <td class="md" valign="top">&nbsp;)&nbsp;</td>
454          <td class="md" nowrap></td>
455        </tr>
456
457      </table>
458    </td>
459  </tr>
460</table>
461<table cellspacing=5 cellpadding=0 border=0>
462  <tr>
463    <td>
464      &nbsp;
465    </td>
466    <td>
467
468<p>
469
470<p>
471Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00228">228</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
472<p>
473References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
474  </tr>
475</table>
476<a class="anchor" name="Ogre_1_1ColourValuea14" doxytag="Ogre::ColourValue::operator-" ></a><p>
477<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
478  <tr>
479    <td class="mdRow">
480      <table cellpadding="0" cellspacing="0" border="0">
481        <tr>
482          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator- </td>
483          <td class="md" valign="top">(&nbsp;</td>
484          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
485          <td class="mdname1" valign="top" nowrap> <em>rkVector</em>          </td>
486          <td class="md" valign="top">&nbsp;)&nbsp;</td>
487          <td class="md" nowrap> const</td>
488        </tr>
489
490      </table>
491    </td>
492  </tr>
493</table>
494<table cellspacing=5 cellpadding=0 border=0>
495  <tr>
496    <td>
497      &nbsp;
498    </td>
499    <td>
500
501<p>
502
503<p>
504Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00152">152</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
505<p>
506References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
507  </tr>
508</table>
509<a class="anchor" name="Ogre_1_1ColourValuea20" doxytag="Ogre::ColourValue::operator-=" ></a><p>
510<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
511  <tr>
512    <td class="mdRow">
513      <table cellpadding="0" cellspacing="0" border="0">
514        <tr>
515          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; Ogre::ColourValue::operator-= </td>
516          <td class="md" valign="top">(&nbsp;</td>
517          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
518          <td class="mdname1" valign="top" nowrap> <em>rkVector</em>          </td>
519          <td class="md" valign="top">&nbsp;)&nbsp;</td>
520          <td class="md" nowrap></td>
521        </tr>
522
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing=5 cellpadding=0 border=0>
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535
536<p>
537Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00238">238</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
538<p>
539References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
540  </tr>
541</table>
542<a class="anchor" name="Ogre_1_1ColourValuea18" doxytag="Ogre::ColourValue::operator/" ></a><p>
543<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
544  <tr>
545    <td class="mdRow">
546      <table cellpadding="0" cellspacing="0" border="0">
547        <tr>
548          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator/ </td>
549          <td class="md" valign="top">(&nbsp;</td>
550          <td class="md" nowrap valign="top">const float&nbsp;</td>
551          <td class="mdname1" valign="top" nowrap> <em>fScalar</em>          </td>
552          <td class="md" valign="top">&nbsp;)&nbsp;</td>
553          <td class="md" nowrap> const</td>
554        </tr>
555
556      </table>
557    </td>
558  </tr>
559</table>
560<table cellspacing=5 cellpadding=0 border=0>
561  <tr>
562    <td>
563      &nbsp;
564    </td>
565    <td>
566
567<p>
568
569<p>
570Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00200">200</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
571<p>
572References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
573  </tr>
574</table>
575<a class="anchor" name="Ogre_1_1ColourValuea17" doxytag="Ogre::ColourValue::operator/" ></a><p>
576<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
577  <tr>
578    <td class="mdRow">
579      <table cellpadding="0" cellspacing="0" border="0">
580        <tr>
581          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::operator/ </td>
582          <td class="md" valign="top">(&nbsp;</td>
583          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
584          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
585          <td class="md" valign="top">&nbsp;)&nbsp;</td>
586          <td class="md" nowrap> const</td>
587        </tr>
588
589      </table>
590    </td>
591  </tr>
592</table>
593<table cellspacing=5 cellpadding=0 border=0>
594  <tr>
595    <td>
596      &nbsp;
597    </td>
598    <td>
599
600<p>
601
602<p>
603Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00188">188</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
604<p>
605References <a class="el" href="OgreColourValue_8h-source.html#l00069">a</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">b</a>, <a class="el" href="OgreColourValue_8h-source.html#l00069">g</a>, and <a class="el" href="OgreColourValue_8h-source.html#l00069">r</a>.    </td>
606  </tr>
607</table>
608<a class="anchor" name="Ogre_1_1ColourValuea22" doxytag="Ogre::ColourValue::operator/=" ></a><p>
609<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
610  <tr>
611    <td class="mdRow">
612      <table cellpadding="0" cellspacing="0" border="0">
613        <tr>
614          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; Ogre::ColourValue::operator/= </td>
615          <td class="md" valign="top">(&nbsp;</td>
616          <td class="md" nowrap valign="top">const float&nbsp;</td>
617          <td class="mdname1" valign="top" nowrap> <em>fScalar</em>          </td>
618          <td class="md" valign="top">&nbsp;)&nbsp;</td>
619          <td class="md" nowrap></td>
620        </tr>
621
622      </table>
623    </td>
624  </tr>
625</table>
626<table cellspacing=5 cellpadding=0 border=0>
627  <tr>
628    <td>
629      &nbsp;
630    </td>
631    <td>
632
633<p>
634
635<p>
636Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00257">257</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
637  </tr>
638</table>
639<a class="anchor" name="Ogre_1_1ColourValuea1" doxytag="Ogre::ColourValue::operator==" ></a><p>
640<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
641  <tr>
642    <td class="mdRow">
643      <table cellpadding="0" cellspacing="0" border="0">
644        <tr>
645          <td class="md" nowrap valign="top"> bool Ogre::ColourValue::operator== </td>
646          <td class="md" valign="top">(&nbsp;</td>
647          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
648          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
649          <td class="md" valign="top">&nbsp;)&nbsp;</td>
650          <td class="md" nowrap> const</td>
651        </tr>
652
653      </table>
654    </td>
655  </tr>
656</table>
657<table cellspacing=5 cellpadding=0 border=0>
658  <tr>
659    <td>
660      &nbsp;
661    </td>
662    <td>
663
664<p>
665    </td>
666  </tr>
667</table>
668<a class="anchor" name="Ogre_1_1ColourValuea11" doxytag="Ogre::ColourValue::saturate" ></a><p>
669<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
670  <tr>
671    <td class="mdRow">
672      <table cellpadding="0" cellspacing="0" border="0">
673        <tr>
674          <td class="md" nowrap valign="top"> void Ogre::ColourValue::saturate </td>
675          <td class="md" valign="top">(&nbsp;</td>
676          <td class="md" nowrap valign="top">void&nbsp;</td>
677          <td class="mdname1" valign="top" nowrap>          </td>
678          <td class="md" valign="top">&nbsp;)&nbsp;</td>
679          <td class="md" nowrap></td>
680        </tr>
681
682      </table>
683    </td>
684  </tr>
685</table>
686<table cellspacing=5 cellpadding=0 border=0>
687  <tr>
688    <td>
689      &nbsp;
690    </td>
691    <td>
692
693<p>
694Clamps colour value to the range [0, 1].
695<p>
696
697<p>
698Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00107">107</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
699<p>
700Referenced by <a class="el" href="OgreColourValue_8h-source.html#l00132">saturateCopy()</a>.    </td>
701  </tr>
702</table>
703<a class="anchor" name="Ogre_1_1ColourValuea12" doxytag="Ogre::ColourValue::saturateCopy" ></a><p>
704<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
705  <tr>
706    <td class="mdRow">
707      <table cellpadding="0" cellspacing="0" border="0">
708        <tr>
709          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::ColourValue::saturateCopy </td>
710          <td class="md" valign="top">(&nbsp;</td>
711          <td class="md" nowrap valign="top">void&nbsp;</td>
712          <td class="mdname1" valign="top" nowrap>          </td>
713          <td class="md" valign="top">&nbsp;)&nbsp;</td>
714          <td class="md" nowrap> const</td>
715        </tr>
716
717      </table>
718    </td>
719  </tr>
720</table>
721<table cellspacing=5 cellpadding=0 border=0>
722  <tr>
723    <td>
724      &nbsp;
725    </td>
726    <td>
727
728<p>
729As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy.
730<p>
731
732<p>
733Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00132">132</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
734<p>
735References <a class="el" href="OgreColourValue_8h-source.html#l00107">saturate()</a>.    </td>
736  </tr>
737</table>
738<a class="anchor" name="Ogre_1_1ColourValuea10" doxytag="Ogre::ColourValue::setAsABGR" ></a><p>
739<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
740  <tr>
741    <td class="mdRow">
742      <table cellpadding="0" cellspacing="0" border="0">
743        <tr>
744          <td class="md" nowrap valign="top"> void Ogre::ColourValue::setAsABGR </td>
745          <td class="md" valign="top">(&nbsp;</td>
746          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a70">ABGR</a>&nbsp;</td>
747          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
748          <td class="md" valign="top">&nbsp;)&nbsp;</td>
749          <td class="md" nowrap></td>
750        </tr>
751
752      </table>
753    </td>
754  </tr>
755</table>
756<table cellspacing=5 cellpadding=0 border=0>
757  <tr>
758    <td>
759      &nbsp;
760    </td>
761    <td>
762
763<p>
764Sets colour as ABGR.
765<p>
766    </td>
767  </tr>
768</table>
769<a class="anchor" name="Ogre_1_1ColourValuea8" doxytag="Ogre::ColourValue::setAsARGB" ></a><p>
770<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
771  <tr>
772    <td class="mdRow">
773      <table cellpadding="0" cellspacing="0" border="0">
774        <tr>
775          <td class="md" nowrap valign="top"> void Ogre::ColourValue::setAsARGB </td>
776          <td class="md" valign="top">(&nbsp;</td>
777          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a69">ARGB</a>&nbsp;</td>
778          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
779          <td class="md" valign="top">&nbsp;)&nbsp;</td>
780          <td class="md" nowrap></td>
781        </tr>
782
783      </table>
784    </td>
785  </tr>
786</table>
787<table cellspacing=5 cellpadding=0 border=0>
788  <tr>
789    <td>
790      &nbsp;
791    </td>
792    <td>
793
794<p>
795Sets colour as ARGB.
796<p>
797    </td>
798  </tr>
799</table>
800<a class="anchor" name="Ogre_1_1ColourValuea9" doxytag="Ogre::ColourValue::setAsBGRA" ></a><p>
801<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
802  <tr>
803    <td class="mdRow">
804      <table cellpadding="0" cellspacing="0" border="0">
805        <tr>
806          <td class="md" nowrap valign="top"> void Ogre::ColourValue::setAsBGRA </td>
807          <td class="md" valign="top">(&nbsp;</td>
808          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a71">BGRA</a>&nbsp;</td>
809          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
810          <td class="md" valign="top">&nbsp;)&nbsp;</td>
811          <td class="md" nowrap></td>
812        </tr>
813
814      </table>
815    </td>
816  </tr>
817</table>
818<table cellspacing=5 cellpadding=0 border=0>
819  <tr>
820    <td>
821      &nbsp;
822    </td>
823    <td>
824
825<p>
826Sets colour as BGRA.
827<p>
828    </td>
829  </tr>
830</table>
831<a class="anchor" name="Ogre_1_1ColourValuea7" doxytag="Ogre::ColourValue::setAsRGBA" ></a><p>
832<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
833  <tr>
834    <td class="mdRow">
835      <table cellpadding="0" cellspacing="0" border="0">
836        <tr>
837          <td class="md" nowrap valign="top"> void Ogre::ColourValue::setAsRGBA </td>
838          <td class="md" valign="top">(&nbsp;</td>
839          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a68">RGBA</a>&nbsp;</td>
840          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
841          <td class="md" valign="top">&nbsp;)&nbsp;</td>
842          <td class="md" nowrap></td>
843        </tr>
844
845      </table>
846    </td>
847  </tr>
848</table>
849<table cellspacing=5 cellpadding=0 border=0>
850  <tr>
851    <td>
852      &nbsp;
853    </td>
854    <td>
855
856<p>
857Sets colour as RGBA.
858<p>
859    </td>
860  </tr>
861</table>
862<a class="anchor" name="Ogre_1_1ColourValuea23" doxytag="Ogre::ColourValue::setHSB" ></a><p>
863<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
864  <tr>
865    <td class="mdRow">
866      <table cellpadding="0" cellspacing="0" border="0">
867        <tr>
868          <td class="md" nowrap valign="top"> void Ogre::ColourValue::setHSB </td>
869          <td class="md" valign="top">(&nbsp;</td>
870          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
871          <td class="mdname" nowrap> <em>hue</em>, </td>
872        </tr>
873        <tr>
874          <td class="md" nowrap align="right"></td>
875          <td></td>
876          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
877          <td class="mdname" nowrap> <em>saturation</em>, </td>
878        </tr>
879        <tr>
880          <td class="md" nowrap align="right"></td>
881          <td></td>
882          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
883          <td class="mdname" nowrap> <em>brightness</em></td>
884        </tr>
885        <tr>
886          <td></td>
887          <td class="md">)&nbsp;</td>
888          <td class="md" colspan="2"></td>
889        </tr>
890
891      </table>
892    </td>
893  </tr>
894</table>
895<table cellspacing=5 cellpadding=0 border=0>
896  <tr>
897    <td>
898      &nbsp;
899    </td>
900    <td>
901
902<p>
903Set a colour value from Hue, Saturation and Brightness.
904<p>
905<dl compact><dt><b>Parameters:</b></dt><dd>
906  <table border="0" cellspacing="2" cellpadding="0">
907    <tr><td valign=top><em>hue</em>&nbsp;</td><td>Hue value, scaled to the [0,1] range as opposed to the 0-360 </td></tr>
908    <tr><td valign=top><em>saturation</em>&nbsp;</td><td>Saturation level, [0,1] </td></tr>
909    <tr><td valign=top><em>brightness</em>&nbsp;</td><td>Brightness level, [0,1]</td></tr>
910  </table>
911</dl>
912    </td>
913  </tr>
914</table>
915<hr><h2>Friends And Related Function Documentation</h2>
916<a class="anchor" name="Ogre_1_1ColourValuen0" doxytag="Ogre::ColourValue::operator *" ></a><p>
917<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
918  <tr>
919    <td class="mdRow">
920      <table cellpadding="0" cellspacing="0" border="0">
921        <tr>
922          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> operator * </td>
923          <td class="md" valign="top">(&nbsp;</td>
924          <td class="md" nowrap valign="top">const float&nbsp;</td>
925          <td class="mdname" nowrap> <em>fScalar</em>, </td>
926        </tr>
927        <tr>
928          <td class="md" nowrap align="right"></td>
929          <td></td>
930          <td class="md" nowrap>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
931          <td class="mdname" nowrap> <em>rkVector</em></td>
932        </tr>
933        <tr>
934          <td></td>
935          <td class="md">)&nbsp;</td>
936          <td class="md" colspan="2"><code> [friend]</code></td>
937        </tr>
938
939      </table>
940    </td>
941  </tr>
942</table>
943<table cellspacing=5 cellpadding=0 border=0>
944  <tr>
945    <td>
946      &nbsp;
947    </td>
948    <td>
949
950<p>
951
952<p>
953Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00215">215</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
954  </tr>
955</table>
956<a class="anchor" name="Ogre_1_1ColourValuen1" doxytag="Ogre::ColourValue::operator<<" ></a><p>
957<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
958  <tr>
959    <td class="mdRow">
960      <table cellpadding="0" cellspacing="0" border="0">
961        <tr>
962          <td class="md" nowrap valign="top"> _OgreExport friend std::ostream&amp; operator&lt;&lt; </td>
963          <td class="md" valign="top">(&nbsp;</td>
964          <td class="md" nowrap valign="top">std::ostream &amp;&nbsp;</td>
965          <td class="mdname" nowrap> <em>o</em>, </td>
966        </tr>
967        <tr>
968          <td class="md" nowrap align="right"></td>
969          <td></td>
970          <td class="md" nowrap>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &amp;&nbsp;</td>
971          <td class="mdname" nowrap> <em>c</em></td>
972        </tr>
973        <tr>
974          <td></td>
975          <td class="md">)&nbsp;</td>
976          <td class="md" colspan="2"><code> [friend]</code></td>
977        </tr>
978
979      </table>
980    </td>
981  </tr>
982</table>
983<table cellspacing=5 cellpadding=0 border=0>
984  <tr>
985    <td>
986      &nbsp;
987    </td>
988    <td>
989
990<p>
991Function for writing to a stream.
992<p>
993
994<p>
995Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00282">282</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
996  </tr>
997</table>
998<hr><h2>Member Data Documentation</h2>
999<a class="anchor" name="Ogre_1_1ColourValueo3" doxytag="Ogre::ColourValue::a" ></a><p>
1000<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1001  <tr>
1002    <td class="mdRow">
1003      <table cellpadding="0" cellspacing="0" border="0">
1004        <tr>
1005          <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo3">Ogre::ColourValue::a</a>
1006      </table>
1007    </td>
1008  </tr>
1009</table>
1010<table cellspacing=5 cellpadding=0 border=0>
1011  <tr>
1012    <td>
1013      &nbsp;
1014    </td>
1015    <td>
1016
1017<p>
1018
1019<p>
1020Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00069">69</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
1021<p>
1022Referenced by <a class="el" href="OgreColourValue_8h-source.html#l00164">operator *()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00140">operator+()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00228">operator+=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00152">operator-()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00238">operator-=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00188">operator/()</a>, and <a class="el" href="OgreAnimable_8h-source.html#l00105">Ogre::AnimableValue::setAsBaseValue()</a>.    </td>
1023  </tr>
1024</table>
1025<a class="anchor" name="Ogre_1_1ColourValueo2" doxytag="Ogre::ColourValue::b" ></a><p>
1026<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1027  <tr>
1028    <td class="mdRow">
1029      <table cellpadding="0" cellspacing="0" border="0">
1030        <tr>
1031          <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo2">Ogre::ColourValue::b</a>
1032      </table>
1033    </td>
1034  </tr>
1035</table>
1036<table cellspacing=5 cellpadding=0 border=0>
1037  <tr>
1038    <td>
1039      &nbsp;
1040    </td>
1041    <td>
1042
1043<p>
1044
1045<p>
1046Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00069">69</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
1047<p>
1048Referenced by <a class="el" href="OgreColourValue_8h-source.html#l00164">operator *()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00140">operator+()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00228">operator+=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00152">operator-()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00238">operator-=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00188">operator/()</a>, and <a class="el" href="OgreAnimable_8h-source.html#l00105">Ogre::AnimableValue::setAsBaseValue()</a>.    </td>
1049  </tr>
1050</table>
1051<a class="anchor" name="Ogre_1_1ColourValues1" doxytag="Ogre::ColourValue::Black" ></a><p>
1052<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1053  <tr>
1054    <td class="mdRow">
1055      <table cellpadding="0" cellspacing="0" border="0">
1056        <tr>
1057          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues1">Ogre::ColourValue::Black</a><code> [static]</code>
1058      </table>
1059    </td>
1060  </tr>
1061</table>
1062<table cellspacing=5 cellpadding=0 border=0>
1063  <tr>
1064    <td>
1065      &nbsp;
1066    </td>
1067    <td>
1068
1069<p>
1070
1071<p>
1072Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00052">52</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1073  </tr>
1074</table>
1075<a class="anchor" name="Ogre_1_1ColourValues5" doxytag="Ogre::ColourValue::Blue" ></a><p>
1076<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1077  <tr>
1078    <td class="mdRow">
1079      <table cellpadding="0" cellspacing="0" border="0">
1080        <tr>
1081          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues5">Ogre::ColourValue::Blue</a><code> [static]</code>
1082      </table>
1083    </td>
1084  </tr>
1085</table>
1086<table cellspacing=5 cellpadding=0 border=0>
1087  <tr>
1088    <td>
1089      &nbsp;
1090    </td>
1091    <td>
1092
1093<p>
1094
1095<p>
1096Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00056">56</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1097  </tr>
1098</table>
1099<a class="anchor" name="Ogre_1_1ColourValueo1" doxytag="Ogre::ColourValue::g" ></a><p>
1100<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1101  <tr>
1102    <td class="mdRow">
1103      <table cellpadding="0" cellspacing="0" border="0">
1104        <tr>
1105          <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo1">Ogre::ColourValue::g</a>
1106      </table>
1107    </td>
1108  </tr>
1109</table>
1110<table cellspacing=5 cellpadding=0 border=0>
1111  <tr>
1112    <td>
1113      &nbsp;
1114    </td>
1115    <td>
1116
1117<p>
1118
1119<p>
1120Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00069">69</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
1121<p>
1122Referenced by <a class="el" href="OgreColourValue_8h-source.html#l00164">operator *()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00140">operator+()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00228">operator+=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00152">operator-()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00238">operator-=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00188">operator/()</a>, and <a class="el" href="OgreAnimable_8h-source.html#l00105">Ogre::AnimableValue::setAsBaseValue()</a>.    </td>
1123  </tr>
1124</table>
1125<a class="anchor" name="Ogre_1_1ColourValues4" doxytag="Ogre::ColourValue::Green" ></a><p>
1126<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1127  <tr>
1128    <td class="mdRow">
1129      <table cellpadding="0" cellspacing="0" border="0">
1130        <tr>
1131          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues4">Ogre::ColourValue::Green</a><code> [static]</code>
1132      </table>
1133    </td>
1134  </tr>
1135</table>
1136<table cellspacing=5 cellpadding=0 border=0>
1137  <tr>
1138    <td>
1139      &nbsp;
1140    </td>
1141    <td>
1142
1143<p>
1144
1145<p>
1146Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00055">55</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1147  </tr>
1148</table>
1149<a class="anchor" name="Ogre_1_1ColourValueo0" doxytag="Ogre::ColourValue::r" ></a><p>
1150<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1151  <tr>
1152    <td class="mdRow">
1153      <table cellpadding="0" cellspacing="0" border="0">
1154        <tr>
1155          <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo0">Ogre::ColourValue::r</a>
1156      </table>
1157    </td>
1158  </tr>
1159</table>
1160<table cellspacing=5 cellpadding=0 border=0>
1161  <tr>
1162    <td>
1163      &nbsp;
1164    </td>
1165    <td>
1166
1167<p>
1168
1169<p>
1170Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00069">69</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.
1171<p>
1172Referenced by <a class="el" href="OgreColourValue_8h-source.html#l00164">operator *()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00140">operator+()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00228">operator+=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00152">operator-()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00238">operator-=()</a>, <a class="el" href="OgreColourValue_8h-source.html#l00188">operator/()</a>, and <a class="el" href="OgreAnimable_8h-source.html#l00105">Ogre::AnimableValue::setAsBaseValue()</a>.    </td>
1173  </tr>
1174</table>
1175<a class="anchor" name="Ogre_1_1ColourValues3" doxytag="Ogre::ColourValue::Red" ></a><p>
1176<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1177  <tr>
1178    <td class="mdRow">
1179      <table cellpadding="0" cellspacing="0" border="0">
1180        <tr>
1181          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues3">Ogre::ColourValue::Red</a><code> [static]</code>
1182      </table>
1183    </td>
1184  </tr>
1185</table>
1186<table cellspacing=5 cellpadding=0 border=0>
1187  <tr>
1188    <td>
1189      &nbsp;
1190    </td>
1191    <td>
1192
1193<p>
1194
1195<p>
1196Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00054">54</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1197  </tr>
1198</table>
1199<a class="anchor" name="Ogre_1_1ColourValueo4" doxytag="Ogre::ColourValue::val" ></a><p>
1200<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1201  <tr>
1202    <td class="mdRow">
1203      <table cellpadding="0" cellspacing="0" border="0">
1204        <tr>
1205          <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValueo4">Ogre::ColourValue::val</a>[4]
1206      </table>
1207    </td>
1208  </tr>
1209</table>
1210<table cellspacing=5 cellpadding=0 border=0>
1211  <tr>
1212    <td>
1213      &nbsp;
1214    </td>
1215    <td>
1216
1217<p>
1218
1219<p>
1220Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00071">71</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1221  </tr>
1222</table>
1223<a class="anchor" name="Ogre_1_1ColourValues2" doxytag="Ogre::ColourValue::White" ></a><p>
1224<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1225  <tr>
1226    <td class="mdRow">
1227      <table cellpadding="0" cellspacing="0" border="0">
1228        <tr>
1229          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues2">Ogre::ColourValue::White</a><code> [static]</code>
1230      </table>
1231    </td>
1232  </tr>
1233</table>
1234<table cellspacing=5 cellpadding=0 border=0>
1235  <tr>
1236    <td>
1237      &nbsp;
1238    </td>
1239    <td>
1240
1241<p>
1242
1243<p>
1244Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00053">53</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1245  </tr>
1246</table>
1247<a class="anchor" name="Ogre_1_1ColourValues0" doxytag="Ogre::ColourValue::ZERO" ></a><p>
1248<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1249  <tr>
1250    <td class="mdRow">
1251      <table cellpadding="0" cellspacing="0" border="0">
1252        <tr>
1253          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1ColourValue.html#Ogre_1_1ColourValues0">Ogre::ColourValue::ZERO</a><code> [static]</code>
1254      </table>
1255    </td>
1256  </tr>
1257</table>
1258<table cellspacing=5 cellpadding=0 border=0>
1259  <tr>
1260    <td>
1261      &nbsp;
1262    </td>
1263    <td>
1264
1265<p>
1266
1267<p>
1268Definition at line <a class="el" href="OgreColourValue_8h-source.html#l00051">51</a> of file <a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a>.    </td>
1269  </tr>
1270</table>
1271<hr>The documentation for this class was generated from the following file:<ul>
1272<li><a class="el" href="OgreColourValue_8h-source.html">OgreColourValue.h</a></ul>
1273<hr>
1274<p>
1275Copyright &copy; 2000-2005 by The OGRE Team<br />
1276<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1277This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1278                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1279                <Work rdf:about="">
1280                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1281        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1282                </Work>
1283                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1284
1285Last modified Sun Mar 12 14:38:23 2006
1286</p>
1287</body>
1288</html>
Note: See TracBrowser for help on using the repository browser.