aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html970
1 files changed, 970 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html
new file mode 100644
index 0000000..4281793
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_s_color.html
@@ -0,0 +1,970 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::video::SColor Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1video_1_1_s_color.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> &#124;
89<a href="#pub-attribs">Public Attributes</a> </div>
90 <div class="headertitle">
91<div class="title">irr::video::SColor Class Reference</div> </div>
92</div>
93<div class="contents">
94<!-- doxytag: class="irr::video::SColor" -->
95<p>Class representing a 32 bit ARGB color.
96 <a href="classirr_1_1video_1_1_s_color.html#details">More...</a></p>
97
98<p><code>#include &lt;<a class="el" href="_s_color_8h_source.html">SColor.h</a>&gt;</code></p>
99
100<p><a href="classirr_1_1video_1_1_s_color-members.html">List of all members.</a></p>
101<h2><a name="pub-methods"></a>
102Public Member Functions</h2>
103<ul>
104<li><a class="el" href="classirr_1_1video_1_1_s_color.html#ab001c0c2515ff5f8a0b324d1345485f4">SColor</a> ()
105<dl class="el"><dd class="mdescRight">Constructor of the Color. Does nothing. <a href="#ab001c0c2515ff5f8a0b324d1345485f4"></a><br/></dl><li><a class="el" href="classirr_1_1video_1_1_s_color.html#aa2ca1fcb9b11375282bb407b635b3dd6">SColor</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> a, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> r, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> g, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> b)
106<dl class="el"><dd class="mdescRight">Constructs the color from 4 values representing the alpha, red, green and blue component. <a href="#aa2ca1fcb9b11375282bb407b635b3dd6"></a><br/></dl><li><a class="el" href="classirr_1_1video_1_1_s_color.html#a56dd5677c3e36d3b33d5d796be2597da">SColor</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> clr)
107<dl class="el"><dd class="mdescRight">Constructs the color from a 32 bit value. Could be another color. <a href="#a56dd5677c3e36d3b33d5d796be2597da"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a9647d09a9d4b9c6fb48a8fa1f2da425c">getAlpha</a> () const
108<dl class="el"><dd class="mdescRight">Returns the alpha component of the color. <a href="#a9647d09a9d4b9c6fb48a8fa1f2da425c"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a29a672f4bae9805970b84c4aef81b9ab">getAverage</a> () const
109<dl class="el"><dd class="mdescRight">Get average intensity of the color in the range [0,255]. <a href="#a29a672f4bae9805970b84c4aef81b9ab"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a26fdbde73081b35a1686f8d21a549544">getBlue</a> () const
110<dl class="el"><dd class="mdescRight">Returns the blue component of the color. <a href="#a26fdbde73081b35a1686f8d21a549544"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a7cba1b914230289de9c91ff28be96bc9">getData</a> (void *data, <a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">ECOLOR_FORMAT</a> format)
111<dl class="el"><dd class="mdescRight">Write the color to data in the defined format. <a href="#a7cba1b914230289de9c91ff28be96bc9"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#ad604ba81e061b0bfe2ccb5f16e29124d">getGreen</a> () const
112<dl class="el"><dd class="mdescRight">Returns the green component of the color. <a href="#ad604ba81e061b0bfe2ccb5f16e29124d"></a><br/></dl><li><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a880760bf37e7c2143cc0b1a0e90a85b1">getInterpolated</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;other, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> d) const
113<dl class="el"><dd class="mdescRight">Interpolates the color with a f32 value to another color. <a href="#a880760bf37e7c2143cc0b1a0e90a85b1"></a><br/></dl><li><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a9e3832dd71062d1d200f11b91cd3a104">getInterpolated_quadratic</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;c1, const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;c2, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> d) const
114<dl class="el"><dd class="mdescRight">Returns interpolated color. ( quadratic ) <a href="#a9e3832dd71062d1d200f11b91cd3a104"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#aa96bfc155c181104c61df9d58ad8be0f">getLightness</a> () const
115<dl class="el"><dd class="mdescRight">Get lightness of the color in the range [0,255]. <a href="#aa96bfc155c181104c61df9d58ad8be0f"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#ad0a78b90a97e8444a1d12e93e7e929ba">getLuminance</a> () const
116<dl class="el"><dd class="mdescRight">Get luminance of the color in the range [0,255]. <a href="#ad0a78b90a97e8444a1d12e93e7e929ba"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#af10d2deaccbde5c958032ed9ec81b59f">getRed</a> () const
117<dl class="el"><dd class="mdescRight">Returns the red component of the color. <a href="#af10d2deaccbde5c958032ed9ec81b59f"></a><br/></dl><li>bool <a class="el" href="classirr_1_1video_1_1_s_color.html#abcacfc84b1a87f148570efb176999104">operator!=</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;other) const
118<dl class="el"><dd class="mdescRight">Compares the color to another color. <a href="#abcacfc84b1a87f148570efb176999104"></a><br/></dl><li><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a1cd25e0e67050af13a15515b7d2c8782">operator+</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;other) const
119<dl class="el"><dd class="mdescRight">Adds two colors, result is clamped to 0..255 values. <a href="#a1cd25e0e67050af13a15515b7d2c8782"></a><br/></dl><li>bool <a class="el" href="classirr_1_1video_1_1_s_color.html#a8e7944ddc658076a2933861a1b99f1e7">operator&lt;</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;other) const
120<dl class="el"><dd class="mdescRight">comparison operator <a href="#a8e7944ddc658076a2933861a1b99f1e7"></a><br/></dl><li>bool <a class="el" href="classirr_1_1video_1_1_s_color.html#a68025038ef1c75c8b7ca64270216f79f">operator==</a> (const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;other) const
121<dl class="el"><dd class="mdescRight">Compares the color to another color. <a href="#a68025038ef1c75c8b7ca64270216f79f"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a8cf295c05c7406cc249843acbb31ec5f">set</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> a, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> r, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> g, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> b)
122<dl class="el"><dd class="mdescRight">Sets all four components of the color at once. <a href="#a8cf295c05c7406cc249843acbb31ec5f"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a4966581260a89f10386bf9d06239c341">set</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> col)
123<li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a7bfe4abc30d563668b947c8bdb055bab">setAlpha</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> a)
124<dl class="el"><dd class="mdescRight">Sets the alpha component of the Color. <a href="#a7bfe4abc30d563668b947c8bdb055bab"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a13d82e6b52d32f7394f3cce041dc2965">setBlue</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> b)
125<dl class="el"><dd class="mdescRight">Sets the blue component of the Color. <a href="#a13d82e6b52d32f7394f3cce041dc2965"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a381f2db0ed17c6b06ba5c8809dce3370">setData</a> (const void *data, <a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">ECOLOR_FORMAT</a> format)
126<dl class="el"><dd class="mdescRight">set the color by expecting data in the given format <a href="#a381f2db0ed17c6b06ba5c8809dce3370"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#af80cfedd5e761216b8bed259963ac948">setGreen</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> g)
127<dl class="el"><dd class="mdescRight">Sets the green component of the Color. <a href="#af80cfedd5e761216b8bed259963ac948"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a950c98714711ae9dd8c5219f83c07693">setRed</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> r)
128<dl class="el"><dd class="mdescRight">Sets the red component of the Color. <a href="#a950c98714711ae9dd8c5219f83c07693"></a><br/></dl><li><a class="el" href="namespaceirr.html#ae9f8ec82692ad3b83c21f555bfa70bcc">u16</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a9a6ad04081a1b15c07746cf84a971565">toA1R5G5B5</a> () const
129<dl class="el"><dd class="mdescRight">Calculates a 16 bit A1R5G5B5 value of this color. <a href="#a9a6ad04081a1b15c07746cf84a971565"></a><br/></dl><li>void <a class="el" href="classirr_1_1video_1_1_s_color.html#a0196acc3dfded9f6161c41f0065267c1">toOpenGLColor</a> (<a class="el" href="namespaceirr.html#a646874f69af8ff87fc10201b0254a761">u8</a> *dest) const
130<dl class="el"><dd class="mdescRight">Converts color to OpenGL color format. <a href="#a0196acc3dfded9f6161c41f0065267c1"></a><br/></dl></ul>
131<h2><a name="pub-attribs"></a>
132Public Attributes</h2>
133<ul>
134<li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a11f2b41eeff9e7f688d322735ca2cfcf">color</a>
135<dl class="el"><dd class="mdescRight">color in A8R8G8B8 Format <a href="#a11f2b41eeff9e7f688d322735ca2cfcf"></a><br/></dl></ul>
136<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
137<div class="textblock"><p>Class representing a 32 bit ARGB color. </p>
138<p>The color values for alpha, red, green, and blue are stored in a single u32. So all four values may be between 0 and 255. Alpha in Irrlicht is opacity, so 0 is fully transparent, 255 is fully opaque (solid). This class is used by most parts of the Irrlicht Engine to specify a color. Another way is using the class <a class="el" href="classirr_1_1video_1_1_s_colorf.html" title="Class representing a color with four floats.">SColorf</a>, which stores the color values in 4 floats. This class must consist of only one u32 and must not use virtual functions. </p>
139
140<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00201">201</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
141</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
142<a class="anchor" id="ab001c0c2515ff5f8a0b324d1345485f4"></a><!-- doxytag: member="irr::video::SColor::SColor" ref="ab001c0c2515ff5f8a0b324d1345485f4" args="()" -->
143<div class="memitem">
144<div class="memproto">
145 <table class="memname">
146 <tr>
147 <td class="memname">irr::video::SColor::SColor </td>
148 <td>(</td>
149 <td class="paramname"></td><td>)</td>
150 <td><code> [inline]</code></td>
151 </tr>
152 </table>
153</div>
154<div class="memdoc">
155
156<p>Constructor of the Color. Does nothing. </p>
157<p>The color value is not initialized to save time. </p>
158
159<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00207">207</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
160
161<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00340">getInterpolated()</a>, <a class="el" href="_s_color_8h_source.html#l00354">getInterpolated_quadratic()</a>, and <a class="el" href="_s_color_8h_source.html#l00328">operator+()</a>.</p>
162
163</div>
164</div>
165<a class="anchor" id="aa2ca1fcb9b11375282bb407b635b3dd6"></a><!-- doxytag: member="irr::video::SColor::SColor" ref="aa2ca1fcb9b11375282bb407b635b3dd6" args="(u32 a, u32 r, u32 g, u32 b)" -->
166<div class="memitem">
167<div class="memproto">
168 <table class="memname">
169 <tr>
170 <td class="memname">irr::video::SColor::SColor </td>
171 <td>(</td>
172 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
173 <td class="paramname"><em>a</em>, </td>
174 </tr>
175 <tr>
176 <td class="paramkey"></td>
177 <td></td>
178 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
179 <td class="paramname"><em>r</em>, </td>
180 </tr>
181 <tr>
182 <td class="paramkey"></td>
183 <td></td>
184 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
185 <td class="paramname"><em>g</em>, </td>
186 </tr>
187 <tr>
188 <td class="paramkey"></td>
189 <td></td>
190 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
191 <td class="paramname"><em>b</em>&#160;</td>
192 </tr>
193 <tr>
194 <td></td>
195 <td>)</td>
196 <td></td><td><code> [inline]</code></td>
197 </tr>
198 </table>
199</div>
200<div class="memdoc">
201
202<p>Constructs the color from 4 values representing the alpha, red, green and blue component. </p>
203<p>Must be values between 0 and 255. </p>
204
205<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00211">211</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
206
207</div>
208</div>
209<a class="anchor" id="a56dd5677c3e36d3b33d5d796be2597da"></a><!-- doxytag: member="irr::video::SColor::SColor" ref="a56dd5677c3e36d3b33d5d796be2597da" args="(u32 clr)" -->
210<div class="memitem">
211<div class="memproto">
212 <table class="memname">
213 <tr>
214 <td class="memname">irr::video::SColor::SColor </td>
215 <td>(</td>
216 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
217 <td class="paramname"><em>clr</em></td><td>)</td>
218 <td><code> [inline]</code></td>
219 </tr>
220 </table>
221</div>
222<div class="memdoc">
223
224<p>Constructs the color from a 32 bit value. Could be another color. </p>
225
226<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00215">215</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
227
228</div>
229</div>
230<hr/><h2>Member Function Documentation</h2>
231<a class="anchor" id="a9647d09a9d4b9c6fb48a8fa1f2da425c"></a><!-- doxytag: member="irr::video::SColor::getAlpha" ref="a9647d09a9d4b9c6fb48a8fa1f2da425c" args="() const " -->
232<div class="memitem">
233<div class="memproto">
234 <table class="memname">
235 <tr>
236 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::video::SColor::getAlpha </td>
237 <td>(</td>
238 <td class="paramname"></td><td>)</td>
239 <td> const<code> [inline]</code></td>
240 </tr>
241 </table>
242</div>
243<div class="memdoc">
244
245<p>Returns the alpha component of the color. </p>
246<p>The alpha component defines how opaque a color is. </p>
247<dl class="return"><dt><b>Returns:</b></dt><dd>The alpha value of the color. 0 is fully transparent, 255 is fully opaque. </dd></dl>
248
249<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00221">221</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
250
251<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
252
253<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00340">getInterpolated()</a>, <a class="el" href="_s_color_8h_source.html#l00354">getInterpolated_quadratic()</a>, <a class="el" href="_s_color_8h_source.html#l00328">operator+()</a>, <a class="el" href="_s_color_8h_source.html#l00481">irr::video::SColorf::SColorf()</a>, and <a class="el" href="_s_color_8h_source.html#l00284">toOpenGLColor()</a>.</p>
254
255</div>
256</div>
257<a class="anchor" id="a29a672f4bae9805970b84c4aef81b9ab"></a><!-- doxytag: member="irr::video::SColor::getAverage" ref="a29a672f4bae9805970b84c4aef81b9ab" args="() const " -->
258<div class="memitem">
259<div class="memproto">
260 <table class="memname">
261 <tr>
262 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::video::SColor::getAverage </td>
263 <td>(</td>
264 <td class="paramname"></td><td>)</td>
265 <td> const<code> [inline]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>Get average intensity of the color in the range [0,255]. </p>
272
273<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00251">251</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
274
275<p>References <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, and <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>.</p>
276
277</div>
278</div>
279<a class="anchor" id="a26fdbde73081b35a1686f8d21a549544"></a><!-- doxytag: member="irr::video::SColor::getBlue" ref="a26fdbde73081b35a1686f8d21a549544" args="() const " -->
280<div class="memitem">
281<div class="memproto">
282 <table class="memname">
283 <tr>
284 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::video::SColor::getBlue </td>
285 <td>(</td>
286 <td class="paramname"></td><td>)</td>
287 <td> const<code> [inline]</code></td>
288 </tr>
289 </table>
290</div>
291<div class="memdoc">
292
293<p>Returns the blue component of the color. </p>
294<dl class="return"><dt><b>Returns:</b></dt><dd>Value between 0 and 255, specifying how blue the color is. 0 means no blue, 255 means full blue. </dd></dl>
295
296<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00236">236</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
297
298<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
299
300<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00251">getAverage()</a>, <a class="el" href="_s_color_8h_source.html#l00407">getData()</a>, <a class="el" href="_s_color_8h_source.html#l00340">getInterpolated()</a>, <a class="el" href="_s_color_8h_source.html#l00354">getInterpolated_quadratic()</a>, <a class="el" href="_s_color_8h_source.html#l00239">getLightness()</a>, <a class="el" href="_s_color_8h_source.html#l00245">getLuminance()</a>, <a class="el" href="_s_color_8h_source.html#l00328">operator+()</a>, <a class="el" href="_s_color_8h_source.html#l00481">irr::video::SColorf::SColorf()</a>, and <a class="el" href="_s_color_8h_source.html#l00284">toOpenGLColor()</a>.</p>
301
302</div>
303</div>
304<a class="anchor" id="a7cba1b914230289de9c91ff28be96bc9"></a><!-- doxytag: member="irr::video::SColor::getData" ref="a7cba1b914230289de9c91ff28be96bc9" args="(void *data, ECOLOR_FORMAT format)" -->
305<div class="memitem">
306<div class="memproto">
307 <table class="memname">
308 <tr>
309 <td class="memname">void irr::video::SColor::getData </td>
310 <td>(</td>
311 <td class="paramtype">void *&#160;</td>
312 <td class="paramname"><em>data</em>, </td>
313 </tr>
314 <tr>
315 <td class="paramkey"></td>
316 <td></td>
317 <td class="paramtype"><a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">ECOLOR_FORMAT</a>&#160;</td>
318 <td class="paramname"><em>format</em>&#160;</td>
319 </tr>
320 <tr>
321 <td></td>
322 <td>)</td>
323 <td></td><td><code> [inline]</code></td>
324 </tr>
325 </table>
326</div>
327<div class="memdoc">
328
329<p>Write the color to data in the defined format. </p>
330<dl><dt><b>Parameters:</b></dt><dd>
331 <table class="params">
332 <tr><td class="paramname">data,:</td><td>target to write the color. Must contain sufficiently large memory to receive the number of bytes neede for format </td></tr>
333 <tr><td class="paramname">format,:</td><td>tells the format used to write the color into data </td></tr>
334 </table>
335 </dd>
336</dl>
337
338<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00407">407</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
339
340<p>References <a class="el" href="_s_color_8h_source.html#l00097">irr::video::A8R8G8B8toA1R5G5B5()</a>, <a class="el" href="_s_color_8h_source.html#l00107">irr::video::A8R8G8B8toR5G6B5()</a>, <a class="el" href="_s_color_8h_source.html#l00447">color</a>, <a class="el" href="_s_color_8h_source.html#l00023">irr::video::ECF_A1R5G5B5</a>, <a class="el" href="_s_color_8h_source.html#l00032">irr::video::ECF_A8R8G8B8</a>, <a class="el" href="_s_color_8h_source.html#l00026">irr::video::ECF_R5G6B5</a>, <a class="el" href="_s_color_8h_source.html#l00029">irr::video::ECF_R8G8B8</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, and <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>.</p>
341
342</div>
343</div>
344<a class="anchor" id="ad604ba81e061b0bfe2ccb5f16e29124d"></a><!-- doxytag: member="irr::video::SColor::getGreen" ref="ad604ba81e061b0bfe2ccb5f16e29124d" args="() const " -->
345<div class="memitem">
346<div class="memproto">
347 <table class="memname">
348 <tr>
349 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::video::SColor::getGreen </td>
350 <td>(</td>
351 <td class="paramname"></td><td>)</td>
352 <td> const<code> [inline]</code></td>
353 </tr>
354 </table>
355</div>
356<div class="memdoc">
357
358<p>Returns the green component of the color. </p>
359<dl class="return"><dt><b>Returns:</b></dt><dd>Value between 0 and 255, specifying how green the color is. 0 means no green, 255 means full green. </dd></dl>
360
361<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00231">231</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
362
363<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
364
365<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00251">getAverage()</a>, <a class="el" href="_s_color_8h_source.html#l00407">getData()</a>, <a class="el" href="_s_color_8h_source.html#l00340">getInterpolated()</a>, <a class="el" href="_s_color_8h_source.html#l00354">getInterpolated_quadratic()</a>, <a class="el" href="_s_color_8h_source.html#l00239">getLightness()</a>, <a class="el" href="_s_color_8h_source.html#l00245">getLuminance()</a>, <a class="el" href="_s_color_8h_source.html#l00328">operator+()</a>, <a class="el" href="_s_color_8h_source.html#l00481">irr::video::SColorf::SColorf()</a>, and <a class="el" href="_s_color_8h_source.html#l00284">toOpenGLColor()</a>.</p>
366
367</div>
368</div>
369<a class="anchor" id="a880760bf37e7c2143cc0b1a0e90a85b1"></a><!-- doxytag: member="irr::video::SColor::getInterpolated" ref="a880760bf37e7c2143cc0b1a0e90a85b1" args="(const SColor &amp;other, f32 d) const " -->
370<div class="memitem">
371<div class="memproto">
372 <table class="memname">
373 <tr>
374 <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> irr::video::SColor::getInterpolated </td>
375 <td>(</td>
376 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
377 <td class="paramname"><em>other</em>, </td>
378 </tr>
379 <tr>
380 <td class="paramkey"></td>
381 <td></td>
382 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
383 <td class="paramname"><em>d</em>&#160;</td>
384 </tr>
385 <tr>
386 <td></td>
387 <td>)</td>
388 <td></td><td> const<code> [inline]</code></td>
389 </tr>
390 </table>
391</div>
392<div class="memdoc">
393
394<p>Interpolates the color with a f32 value to another color. </p>
395<dl><dt><b>Parameters:</b></dt><dd>
396 <table class="params">
397 <tr><td class="paramname">other,:</td><td>Other color </td></tr>
398 <tr><td class="paramname">d,:</td><td>value between 0.0f and 1.0f </td></tr>
399 </table>
400 </dd>
401</dl>
402<dl class="return"><dt><b>Returns:</b></dt><dd>Interpolated color. </dd></dl>
403
404<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00340">340</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
405
406<p>References <a class="el" href="irr_math_8h_source.html#l00166">irr::core::clamp()</a>, <a class="el" href="_s_color_8h_source.html#l00221">getAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>, <a class="el" href="irr_math_8h_source.html#l00680">irr::core::round32()</a>, and <a class="el" href="_s_color_8h_source.html#l00207">SColor()</a>.</p>
407
408<p>Referenced by <a class="el" href="_s3_d_vertex_8h_source.html#l00093">irr::video::S3DVertex::getInterpolated()</a>, <a class="el" href="_s3_d_vertex_8h_source.html#l00171">irr::video::S3DVertex2TCoords::getInterpolated()</a>, and <a class="el" href="_s3_d_vertex_8h_source.html#l00242">irr::video::S3DVertexTangents::getInterpolated()</a>.</p>
409
410</div>
411</div>
412<a class="anchor" id="a9e3832dd71062d1d200f11b91cd3a104"></a><!-- doxytag: member="irr::video::SColor::getInterpolated_quadratic" ref="a9e3832dd71062d1d200f11b91cd3a104" args="(const SColor &amp;c1, const SColor &amp;c2, f32 d) const " -->
413<div class="memitem">
414<div class="memproto">
415 <table class="memname">
416 <tr>
417 <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> irr::video::SColor::getInterpolated_quadratic </td>
418 <td>(</td>
419 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
420 <td class="paramname"><em>c1</em>, </td>
421 </tr>
422 <tr>
423 <td class="paramkey"></td>
424 <td></td>
425 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
426 <td class="paramname"><em>c2</em>, </td>
427 </tr>
428 <tr>
429 <td class="paramkey"></td>
430 <td></td>
431 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
432 <td class="paramname"><em>d</em>&#160;</td>
433 </tr>
434 <tr>
435 <td></td>
436 <td>)</td>
437 <td></td><td> const<code> [inline]</code></td>
438 </tr>
439 </table>
440</div>
441<div class="memdoc">
442
443<p>Returns interpolated color. ( quadratic ) </p>
444<dl><dt><b>Parameters:</b></dt><dd>
445 <table class="params">
446 <tr><td class="paramname">c1,:</td><td>first color to interpolate with </td></tr>
447 <tr><td class="paramname">c2,:</td><td>second color to interpolate with </td></tr>
448 <tr><td class="paramname">d,:</td><td>value between 0.0f and 1.0f. </td></tr>
449 </table>
450 </dd>
451</dl>
452
453<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00354">354</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
454
455<p>References <a class="el" href="irr_math_8h_source.html#l00166">irr::core::clamp()</a>, <a class="el" href="irr_math_8h_source.html#l00613">irr::core::floor32()</a>, <a class="el" href="_s_color_8h_source.html#l00221">getAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>, and <a class="el" href="_s_color_8h_source.html#l00207">SColor()</a>.</p>
456
457</div>
458</div>
459<a class="anchor" id="aa96bfc155c181104c61df9d58ad8be0f"></a><!-- doxytag: member="irr::video::SColor::getLightness" ref="aa96bfc155c181104c61df9d58ad8be0f" args="() const " -->
460<div class="memitem">
461<div class="memproto">
462 <table class="memname">
463 <tr>
464 <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::video::SColor::getLightness </td>
465 <td>(</td>
466 <td class="paramname"></td><td>)</td>
467 <td> const<code> [inline]</code></td>
468 </tr>
469 </table>
470</div>
471<div class="memdoc">
472
473<p>Get lightness of the color in the range [0,255]. </p>
474
475<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00239">239</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
476
477<p>References <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>, <a class="el" href="irr_math_8h_source.html#l00137">irr::core::max_()</a>, and <a class="el" href="irr_math_8h_source.html#l00123">irr::core::min_()</a>.</p>
478
479</div>
480</div>
481<a class="anchor" id="ad0a78b90a97e8444a1d12e93e7e929ba"></a><!-- doxytag: member="irr::video::SColor::getLuminance" ref="ad0a78b90a97e8444a1d12e93e7e929ba" args="() const " -->
482<div class="memitem">
483<div class="memproto">
484 <table class="memname">
485 <tr>
486 <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::video::SColor::getLuminance </td>
487 <td>(</td>
488 <td class="paramname"></td><td>)</td>
489 <td> const<code> [inline]</code></td>
490 </tr>
491 </table>
492</div>
493<div class="memdoc">
494
495<p>Get luminance of the color in the range [0,255]. </p>
496
497<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00245">245</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
498
499<p>References <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, and <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>.</p>
500
501</div>
502</div>
503<a class="anchor" id="af10d2deaccbde5c958032ed9ec81b59f"></a><!-- doxytag: member="irr::video::SColor::getRed" ref="af10d2deaccbde5c958032ed9ec81b59f" args="() const " -->
504<div class="memitem">
505<div class="memproto">
506 <table class="memname">
507 <tr>
508 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::video::SColor::getRed </td>
509 <td>(</td>
510 <td class="paramname"></td><td>)</td>
511 <td> const<code> [inline]</code></td>
512 </tr>
513 </table>
514</div>
515<div class="memdoc">
516
517<p>Returns the red component of the color. </p>
518<dl class="return"><dt><b>Returns:</b></dt><dd>Value between 0 and 255, specifying how red the color is. 0 means no red, 255 means full red. </dd></dl>
519
520<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00226">226</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
521
522<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
523
524<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00251">getAverage()</a>, <a class="el" href="_s_color_8h_source.html#l00407">getData()</a>, <a class="el" href="_s_color_8h_source.html#l00340">getInterpolated()</a>, <a class="el" href="_s_color_8h_source.html#l00354">getInterpolated_quadratic()</a>, <a class="el" href="_s_color_8h_source.html#l00239">getLightness()</a>, <a class="el" href="_s_color_8h_source.html#l00245">getLuminance()</a>, <a class="el" href="_s_color_8h_source.html#l00328">operator+()</a>, <a class="el" href="_s_color_8h_source.html#l00481">irr::video::SColorf::SColorf()</a>, and <a class="el" href="_s_color_8h_source.html#l00284">toOpenGLColor()</a>.</p>
525
526</div>
527</div>
528<a class="anchor" id="abcacfc84b1a87f148570efb176999104"></a><!-- doxytag: member="irr::video::SColor::operator!=" ref="abcacfc84b1a87f148570efb176999104" args="(const SColor &amp;other) const " -->
529<div class="memitem">
530<div class="memproto">
531 <table class="memname">
532 <tr>
533 <td class="memname">bool irr::video::SColor::operator!= </td>
534 <td>(</td>
535 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
536 <td class="paramname"><em>other</em></td><td>)</td>
537 <td> const<code> [inline]</code></td>
538 </tr>
539 </table>
540</div>
541<div class="memdoc">
542
543<p>Compares the color to another color. </p>
544<dl class="return"><dt><b>Returns:</b></dt><dd>True if the colors are different, and false if they are the same. </dd></dl>
545
546<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00319">319</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
547
548<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
549
550</div>
551</div>
552<a class="anchor" id="a1cd25e0e67050af13a15515b7d2c8782"></a><!-- doxytag: member="irr::video::SColor::operator+" ref="a1cd25e0e67050af13a15515b7d2c8782" args="(const SColor &amp;other) const " -->
553<div class="memitem">
554<div class="memproto">
555 <table class="memname">
556 <tr>
557 <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> irr::video::SColor::operator+ </td>
558 <td>(</td>
559 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
560 <td class="paramname"><em>other</em></td><td>)</td>
561 <td> const<code> [inline]</code></td>
562 </tr>
563 </table>
564</div>
565<div class="memdoc">
566
567<p>Adds two colors, result is clamped to 0..255 values. </p>
568<dl><dt><b>Parameters:</b></dt><dd>
569 <table class="params">
570 <tr><td class="paramname">other</td><td>Color to add to this color </td></tr>
571 </table>
572 </dd>
573</dl>
574<dl class="return"><dt><b>Returns:</b></dt><dd>Addition of the two colors, clamped to 0..255 values </dd></dl>
575
576<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00328">328</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
577
578<p>References <a class="el" href="_s_color_8h_source.html#l00221">getAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>, <a class="el" href="irr_math_8h_source.html#l00123">irr::core::min_()</a>, and <a class="el" href="_s_color_8h_source.html#l00207">SColor()</a>.</p>
579
580</div>
581</div>
582<a class="anchor" id="a8e7944ddc658076a2933861a1b99f1e7"></a><!-- doxytag: member="irr::video::SColor::operator&lt;" ref="a8e7944ddc658076a2933861a1b99f1e7" args="(const SColor &amp;other) const " -->
583<div class="memitem">
584<div class="memproto">
585 <table class="memname">
586 <tr>
587 <td class="memname">bool irr::video::SColor::operator&lt; </td>
588 <td>(</td>
589 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
590 <td class="paramname"><em>other</em></td><td>)</td>
591 <td> const<code> [inline]</code></td>
592 </tr>
593 </table>
594</div>
595<div class="memdoc">
596
597<p>comparison operator </p>
598<dl class="return"><dt><b>Returns:</b></dt><dd>True if this color is smaller than the other one </dd></dl>
599
600<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00323">323</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
601
602<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
603
604</div>
605</div>
606<a class="anchor" id="a68025038ef1c75c8b7ca64270216f79f"></a><!-- doxytag: member="irr::video::SColor::operator==" ref="a68025038ef1c75c8b7ca64270216f79f" args="(const SColor &amp;other) const " -->
607<div class="memitem">
608<div class="memproto">
609 <table class="memname">
610 <tr>
611 <td class="memname">bool irr::video::SColor::operator== </td>
612 <td>(</td>
613 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> &amp;&#160;</td>
614 <td class="paramname"><em>other</em></td><td>)</td>
615 <td> const<code> [inline]</code></td>
616 </tr>
617 </table>
618</div>
619<div class="memdoc">
620
621<p>Compares the color to another color. </p>
622<dl class="return"><dt><b>Returns:</b></dt><dd>True if the colors are the same, and false if not. </dd></dl>
623
624<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00315">315</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
625
626<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
627
628</div>
629</div>
630<a class="anchor" id="a8cf295c05c7406cc249843acbb31ec5f"></a><!-- doxytag: member="irr::video::SColor::set" ref="a8cf295c05c7406cc249843acbb31ec5f" args="(u32 a, u32 r, u32 g, u32 b)" -->
631<div class="memitem">
632<div class="memproto">
633 <table class="memname">
634 <tr>
635 <td class="memname">void irr::video::SColor::set </td>
636 <td>(</td>
637 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
638 <td class="paramname"><em>a</em>, </td>
639 </tr>
640 <tr>
641 <td class="paramkey"></td>
642 <td></td>
643 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
644 <td class="paramname"><em>r</em>, </td>
645 </tr>
646 <tr>
647 <td class="paramkey"></td>
648 <td></td>
649 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
650 <td class="paramname"><em>g</em>, </td>
651 </tr>
652 <tr>
653 <td class="paramkey"></td>
654 <td></td>
655 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
656 <td class="paramname"><em>b</em>&#160;</td>
657 </tr>
658 <tr>
659 <td></td>
660 <td>)</td>
661 <td></td><td><code> [inline]</code></td>
662 </tr>
663 </table>
664</div>
665<div class="memdoc">
666
667<p>Sets all four components of the color at once. </p>
668<p>Constructs the color from 4 values representing the alpha, red, green and blue components of the color. Must be values between 0 and 255. </p>
669<dl><dt><b>Parameters:</b></dt><dd>
670 <table class="params">
671 <tr><td class="paramname">a,:</td><td>Alpha component of the color. The alpha component defines how transparent a color should be. Has to be a value between 0 and 255. 255 means not transparent (opaque), 0 means fully transparent. </td></tr>
672 <tr><td class="paramname">r,:</td><td>Sets the red component of the Color. Has to be a value between 0 and 255. 0 means no red, 255 means full red. </td></tr>
673 <tr><td class="paramname">g,:</td><td>Sets the green component of the Color. Has to be a value between 0 and 255. 0 means no green, 255 means full green. </td></tr>
674 <tr><td class="paramname">b,:</td><td>Sets the blue component of the Color. Has to be a value between 0 and 255. 0 means no blue, 255 means full blue. </td></tr>
675 </table>
676 </dd>
677</dl>
678
679<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00307">307</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
680
681<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
682
683</div>
684</div>
685<a class="anchor" id="a4966581260a89f10386bf9d06239c341"></a><!-- doxytag: member="irr::video::SColor::set" ref="a4966581260a89f10386bf9d06239c341" args="(u32 col)" -->
686<div class="memitem">
687<div class="memproto">
688 <table class="memname">
689 <tr>
690 <td class="memname">void irr::video::SColor::set </td>
691 <td>(</td>
692 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
693 <td class="paramname"><em>col</em></td><td>)</td>
694 <td><code> [inline]</code></td>
695 </tr>
696 </table>
697</div>
698<div class="memdoc">
699
700<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00311">311</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
701
702<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
703
704</div>
705</div>
706<a class="anchor" id="a7bfe4abc30d563668b947c8bdb055bab"></a><!-- doxytag: member="irr::video::SColor::setAlpha" ref="a7bfe4abc30d563668b947c8bdb055bab" args="(u32 a)" -->
707<div class="memitem">
708<div class="memproto">
709 <table class="memname">
710 <tr>
711 <td class="memname">void irr::video::SColor::setAlpha </td>
712 <td>(</td>
713 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
714 <td class="paramname"><em>a</em></td><td>)</td>
715 <td><code> [inline]</code></td>
716 </tr>
717 </table>
718</div>
719<div class="memdoc">
720
721<p>Sets the alpha component of the Color. </p>
722<p>The alpha component defines how transparent a color should be. </p>
723<dl><dt><b>Parameters:</b></dt><dd>
724 <table class="params">
725 <tr><td class="paramname">a</td><td>The alpha value of the color. 0 is fully transparent, 255 is fully opaque. </td></tr>
726 </table>
727 </dd>
728</dl>
729
730<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00259">259</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
731
732<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
733
734</div>
735</div>
736<a class="anchor" id="a13d82e6b52d32f7394f3cce041dc2965"></a><!-- doxytag: member="irr::video::SColor::setBlue" ref="a13d82e6b52d32f7394f3cce041dc2965" args="(u32 b)" -->
737<div class="memitem">
738<div class="memproto">
739 <table class="memname">
740 <tr>
741 <td class="memname">void irr::video::SColor::setBlue </td>
742 <td>(</td>
743 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
744 <td class="paramname"><em>b</em></td><td>)</td>
745 <td><code> [inline]</code></td>
746 </tr>
747 </table>
748</div>
749<div class="memdoc">
750
751<p>Sets the blue component of the Color. </p>
752<dl><dt><b>Parameters:</b></dt><dd>
753 <table class="params">
754 <tr><td class="paramname">b,:</td><td>Has to be a value between 0 and 255. 0 means no blue, 255 means full blue. </td></tr>
755 </table>
756 </dd>
757</dl>
758
759<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00274">274</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
760
761<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
762
763</div>
764</div>
765<a class="anchor" id="a381f2db0ed17c6b06ba5c8809dce3370"></a><!-- doxytag: member="irr::video::SColor::setData" ref="a381f2db0ed17c6b06ba5c8809dce3370" args="(const void *data, ECOLOR_FORMAT format)" -->
766<div class="memitem">
767<div class="memproto">
768 <table class="memname">
769 <tr>
770 <td class="memname">void irr::video::SColor::setData </td>
771 <td>(</td>
772 <td class="paramtype">const void *&#160;</td>
773 <td class="paramname"><em>data</em>, </td>
774 </tr>
775 <tr>
776 <td class="paramkey"></td>
777 <td></td>
778 <td class="paramtype"><a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">ECOLOR_FORMAT</a>&#160;</td>
779 <td class="paramname"><em>format</em>&#160;</td>
780 </tr>
781 <tr>
782 <td></td>
783 <td>)</td>
784 <td></td><td><code> [inline]</code></td>
785 </tr>
786 </table>
787</div>
788<div class="memdoc">
789
790<p>set the color by expecting data in the given format </p>
791<dl><dt><b>Parameters:</b></dt><dd>
792 <table class="params">
793 <tr><td class="paramname">data,:</td><td>must point to valid memory containing color information in the given format </td></tr>
794 <tr><td class="paramname">format,:</td><td>tells the format in which data is available </td></tr>
795 </table>
796 </dd>
797</dl>
798
799<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00378">378</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
800
801<p>References <a class="el" href="_s_color_8h_source.html#l00117">irr::video::A1R5G5B5toA8R8G8B8()</a>, <a class="el" href="_s_color_8h_source.html#l00447">color</a>, <a class="el" href="_s_color_8h_source.html#l00023">irr::video::ECF_A1R5G5B5</a>, <a class="el" href="_s_color_8h_source.html#l00032">irr::video::ECF_A8R8G8B8</a>, <a class="el" href="_s_color_8h_source.html#l00026">irr::video::ECF_R5G6B5</a>, <a class="el" href="_s_color_8h_source.html#l00029">irr::video::ECF_R8G8B8</a>, and <a class="el" href="_s_color_8h_source.html#l00128">irr::video::R5G6B5toA8R8G8B8()</a>.</p>
802
803</div>
804</div>
805<a class="anchor" id="af80cfedd5e761216b8bed259963ac948"></a><!-- doxytag: member="irr::video::SColor::setGreen" ref="af80cfedd5e761216b8bed259963ac948" args="(u32 g)" -->
806<div class="memitem">
807<div class="memproto">
808 <table class="memname">
809 <tr>
810 <td class="memname">void irr::video::SColor::setGreen </td>
811 <td>(</td>
812 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
813 <td class="paramname"><em>g</em></td><td>)</td>
814 <td><code> [inline]</code></td>
815 </tr>
816 </table>
817</div>
818<div class="memdoc">
819
820<p>Sets the green component of the Color. </p>
821<dl><dt><b>Parameters:</b></dt><dd>
822 <table class="params">
823 <tr><td class="paramname">g,:</td><td>Has to be a value between 0 and 255. 0 means no green, 255 means full green. </td></tr>
824 </table>
825 </dd>
826</dl>
827
828<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00269">269</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
829
830<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
831
832</div>
833</div>
834<a class="anchor" id="a950c98714711ae9dd8c5219f83c07693"></a><!-- doxytag: member="irr::video::SColor::setRed" ref="a950c98714711ae9dd8c5219f83c07693" args="(u32 r)" -->
835<div class="memitem">
836<div class="memproto">
837 <table class="memname">
838 <tr>
839 <td class="memname">void irr::video::SColor::setRed </td>
840 <td>(</td>
841 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
842 <td class="paramname"><em>r</em></td><td>)</td>
843 <td><code> [inline]</code></td>
844 </tr>
845 </table>
846</div>
847<div class="memdoc">
848
849<p>Sets the red component of the Color. </p>
850<dl><dt><b>Parameters:</b></dt><dd>
851 <table class="params">
852 <tr><td class="paramname">r,:</td><td>Has to be a value between 0 and 255. 0 means no red, 255 means full red. </td></tr>
853 </table>
854 </dd>
855</dl>
856
857<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00264">264</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
858
859<p>References <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
860
861</div>
862</div>
863<a class="anchor" id="a9a6ad04081a1b15c07746cf84a971565"></a><!-- doxytag: member="irr::video::SColor::toA1R5G5B5" ref="a9a6ad04081a1b15c07746cf84a971565" args="() const " -->
864<div class="memitem">
865<div class="memproto">
866 <table class="memname">
867 <tr>
868 <td class="memname"><a class="el" href="namespaceirr.html#ae9f8ec82692ad3b83c21f555bfa70bcc">u16</a> irr::video::SColor::toA1R5G5B5 </td>
869 <td>(</td>
870 <td class="paramname"></td><td>)</td>
871 <td> const<code> [inline]</code></td>
872 </tr>
873 </table>
874</div>
875<div class="memdoc">
876
877<p>Calculates a 16 bit A1R5G5B5 value of this color. </p>
878<dl class="return"><dt><b>Returns:</b></dt><dd>16 bit A1R5G5B5 value of this color. </dd></dl>
879
880<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00278">278</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
881
882<p>References <a class="el" href="_s_color_8h_source.html#l00097">irr::video::A8R8G8B8toA1R5G5B5()</a>, and <a class="el" href="_s_color_8h_source.html#l00447">color</a>.</p>
883
884</div>
885</div>
886<a class="anchor" id="a0196acc3dfded9f6161c41f0065267c1"></a><!-- doxytag: member="irr::video::SColor::toOpenGLColor" ref="a0196acc3dfded9f6161c41f0065267c1" args="(u8 *dest) const " -->
887<div class="memitem">
888<div class="memproto">
889 <table class="memname">
890 <tr>
891 <td class="memname">void irr::video::SColor::toOpenGLColor </td>
892 <td>(</td>
893 <td class="paramtype"><a class="el" href="namespaceirr.html#a646874f69af8ff87fc10201b0254a761">u8</a> *&#160;</td>
894 <td class="paramname"><em>dest</em></td><td>)</td>
895 <td> const<code> [inline]</code></td>
896 </tr>
897 </table>
898</div>
899<div class="memdoc">
900
901<p>Converts color to OpenGL color format. </p>
902<p>From ARGB to RGBA in 4 byte components for endian aware passing to OpenGL </p>
903<dl><dt><b>Parameters:</b></dt><dd>
904 <table class="params">
905 <tr><td class="paramname">dest,:</td><td>address where the 4x8 bit OpenGL color is stored. </td></tr>
906 </table>
907 </dd>
908</dl>
909
910<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00284">284</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
911
912<p>References <a class="el" href="_s_color_8h_source.html#l00221">getAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, and <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>.</p>
913
914</div>
915</div>
916<hr/><h2>Member Data Documentation</h2>
917<a class="anchor" id="a11f2b41eeff9e7f688d322735ca2cfcf"></a><!-- doxytag: member="irr::video::SColor::color" ref="a11f2b41eeff9e7f688d322735ca2cfcf" args="" -->
918<div class="memitem">
919<div class="memproto">
920 <table class="memname">
921 <tr>
922 <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1video_1_1_s_color.html#a11f2b41eeff9e7f688d322735ca2cfcf">irr::video::SColor::color</a></td>
923 </tr>
924 </table>
925</div>
926<div class="memdoc">
927
928<p>color in A8R8G8B8 Format </p>
929
930<p>Definition at line <a class="el" href="_s_color_8h_source.html#l00447">447</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p>
931
932<p>Referenced by <a class="el" href="_s_color_8h_source.html#l00221">getAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00236">getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00407">getData()</a>, <a class="el" href="_s_color_8h_source.html#l00231">getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00226">getRed()</a>, <a class="el" href="_s_color_8h_source.html#l00319">operator!=()</a>, <a class="el" href="_s_color_8h_source.html#l00323">operator&lt;()</a>, <a class="el" href="_s_color_8h_source.html#l00315">operator==()</a>, <a class="el" href="_s_color_8h_source.html#l00307">set()</a>, <a class="el" href="_s_color_8h_source.html#l00259">setAlpha()</a>, <a class="el" href="_s_color_8h_source.html#l00274">setBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00378">setData()</a>, <a class="el" href="_s_color_8h_source.html#l00269">setGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00264">setRed()</a>, and <a class="el" href="_s_color_8h_source.html#l00278">toA1R5G5B5()</a>.</p>
933
934</div>
935</div>
936<hr/>The documentation for this class was generated from the following file:<ul>
937<li><a class="el" href="_s_color_8h_source.html">SColor.h</a></li>
938</ul>
939</div>
940</div>
941 <div id="nav-path" class="navpath">
942 <ul>
943 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
944 <li class="navelem"><a class="el" href="namespaceirr_1_1video.html">video</a> </li>
945 <li class="navelem"><a class="el" href="classirr_1_1video_1_1_s_color.html">SColor</a> </li>
946<!-- window showing the filter options -->
947<div id="MSearchSelectWindow"
948 onmouseover="return searchBox.OnSearchSelectShow()"
949 onmouseout="return searchBox.OnSearchSelectHide()"
950 onkeydown="return searchBox.OnSearchSelectKey(event)">
951<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
952
953<!-- iframe showing the search results (closed by default) -->
954<div id="MSearchResultsWindow">
955<iframe src="javascript:void(0)" frameborder="0"
956 name="MSearchResults" id="MSearchResults">
957</iframe>
958</div>
959
960
961 <li class="footer">
962<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
963Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:48 for Irrlicht 3D Engine by
964<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
965 </ul>
966 </div>
967
968
969</body>
970</html>
generated by cgit v1.1 at 2024-06-27 09:12:15 +0000