<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Irrlicht 3D Engine: irr::video::SColorHSL Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">Irrlicht 3D Engine </div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="dynsections.js"></script> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classirr_1_1video_1_1_s_color_h_s_l.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">irr::video::SColorHSL Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="irr::video::SColorHSL" --> <p>Class representing a color in HSL format. <a href="classirr_1_1video_1_1_s_color_h_s_l.html#details">More...</a></p> <p><code>#include <<a class="el" href="_s_color_8h_source.html">SColor.h</a>></code></p> <p><a href="classirr_1_1video_1_1_s_color_h_s_l-members.html">List of all members.</a></p> <h2><a name="pub-methods"></a> Public Member Functions</h2> <ul> <li><a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#ad75a96f226bcbb38a2237fb7be22f537">SColorHSL</a> (<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> h=0.f, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> s=0.f, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> l=0.f) <li>void <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#ac5806ad1f238083ac59d6f3d21673e94">fromRGB</a> (const <a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> &color) <li>void <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#ad0dc9336487c0912d4d72ba3b803f6c6">toRGB</a> (<a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> &color) const </ul> <h2><a name="pub-attribs"></a> Public Attributes</h2> <ul> <li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#a76d317e46d5a30982ed3da58401d319f">Hue</a> <li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#acc584a689cf0e4a312c07d58f2a9f2b4">Luminance</a> <li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#a61a3b30e3a7724ec9d091001e411987e">Saturation</a> </ul> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Class representing a color in HSL format. </p> <p>The color values for hue, saturation, luminance are stored in 32bit floating point variables. Hue is in range [0,360], Luminance and Saturation are in percent [0,100] </p> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00592">592</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad75a96f226bcbb38a2237fb7be22f537"></a><!-- doxytag: member="irr::video::SColorHSL::SColorHSL" ref="ad75a96f226bcbb38a2237fb7be22f537" args="(f32 h=0.f, f32 s=0.f, f32 l=0.f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">irr::video::SColorHSL::SColorHSL </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"><em>h</em> = <code>0.f</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"><em>s</em> = <code>0.f</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"><em>l</em> = <code>0.f</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00595">595</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ac5806ad1f238083ac59d6f3d21673e94"></a><!-- doxytag: member="irr::video::SColorHSL::fromRGB" ref="ac5806ad1f238083ac59d6f3d21673e94" args="(const SColorf &color)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void irr::video::SColorHSL::fromRGB </td> <td>(</td> <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> & </td> <td class="paramname"><em>color</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00610">610</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> <p>References <a class="el" href="irr_math_8h_source.html#l00185">irr::core::equals()</a>, <a class="el" href="_s_color_8h_source.html#l00571">irr::video::SColorf::getBlue()</a>, <a class="el" href="_s_color_8h_source.html#l00568">irr::video::SColorf::getGreen()</a>, <a class="el" href="_s_color_8h_source.html#l00565">irr::video::SColorf::getRed()</a>, <a class="el" href="_s_color_8h_source.html#l00601">Hue</a>, <a class="el" href="_s_color_8h_source.html#l00603">Luminance</a>, <a class="el" href="irr_math_8h_source.html#l00137">irr::core::max_()</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#l00602">Saturation</a>.</p> </div> </div> <a class="anchor" id="ad0dc9336487c0912d4d72ba3b803f6c6"></a><!-- doxytag: member="irr::video::SColorHSL::toRGB" ref="ad0dc9336487c0912d4d72ba3b803f6c6" args="(SColorf &color) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void irr::video::SColorHSL::toRGB </td> <td>(</td> <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> & </td> <td class="paramname"><em>color</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00646">646</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> <p>References <a class="el" href="_s_color_8h_source.html#l00601">Hue</a>, <a class="el" href="irr_math_8h_source.html#l00270">irr::core::iszero()</a>, <a class="el" href="_s_color_8h_source.html#l00603">Luminance</a>, <a class="el" href="_s_color_8h_source.html#l00602">Saturation</a>, and <a class="el" href="_s_color_8h_source.html#l00503">irr::video::SColorf::set()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a76d317e46d5a30982ed3da58401d319f"></a><!-- doxytag: member="irr::video::SColorHSL::Hue" ref="a76d317e46d5a30982ed3da58401d319f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#a76d317e46d5a30982ed3da58401d319f">irr::video::SColorHSL::Hue</a></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00601">601</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> <p>Referenced by <a class="el" href="_s_color_8h_source.html#l00610">fromRGB()</a>, and <a class="el" href="_s_color_8h_source.html#l00646">toRGB()</a>.</p> </div> </div> <a class="anchor" id="acc584a689cf0e4a312c07d58f2a9f2b4"></a><!-- doxytag: member="irr::video::SColorHSL::Luminance" ref="acc584a689cf0e4a312c07d58f2a9f2b4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#acc584a689cf0e4a312c07d58f2a9f2b4">irr::video::SColorHSL::Luminance</a></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00603">603</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> <p>Referenced by <a class="el" href="_s_color_8h_source.html#l00610">fromRGB()</a>, and <a class="el" href="_s_color_8h_source.html#l00646">toRGB()</a>.</p> </div> </div> <a class="anchor" id="a61a3b30e3a7724ec9d091001e411987e"></a><!-- doxytag: member="irr::video::SColorHSL::Saturation" ref="a61a3b30e3a7724ec9d091001e411987e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html#a61a3b30e3a7724ec9d091001e411987e">irr::video::SColorHSL::Saturation</a></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_s_color_8h_source.html#l00602">602</a> of file <a class="el" href="_s_color_8h_source.html">SColor.h</a>.</p> <p>Referenced by <a class="el" href="_s_color_8h_source.html#l00610">fromRGB()</a>, and <a class="el" href="_s_color_8h_source.html#l00646">toRGB()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="_s_color_8h_source.html">SColor.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> <li class="navelem"><a class="el" href="namespaceirr_1_1video.html">video</a> </li> <li class="navelem"><a class="el" href="classirr_1_1video_1_1_s_color_h_s_l.html">SColorHSL</a> </li> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <li class="footer"> <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:48 for Irrlicht 3D Engine by <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> </ul> </div> </body> </html>