Updated doxygen for 0.9.6 API
This commit is contained in:
Christophe Riccio
@@ -3,8 +3,8 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.5"/>
|
||||
<title>GLM: GLM_GTX_color_space</title>
|
||||
<meta name="generator" content="Doxygen 1.8.8"/>
|
||||
<title>0.9.6: GLM_GTX_common</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
@@ -16,9 +16,9 @@
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">GLM
|
||||
 <span id="projectnumber">0.9.5</span>
|
||||
<div id="projectname">0.9.6
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -26,13 +26,11 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.5 -->
|
||||
<!-- Generated by Doxygen 1.8.8 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -41,166 +39,45 @@
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_color_space<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_common<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gaef4a1b7ed5bec43e245cd152951ec28a">hsvColor</a> (detail::tvec3< T, P > const &rgbValue)</td></tr>
|
||||
<tr class="separator:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gac62caac6baddd276a9569b3630fd47bf"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gac62caac6baddd276a9569b3630fd47bf"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gac62caac6baddd276a9569b3630fd47bf">luminosity</a> (detail::tvec3< T, P > const &color)</td></tr>
|
||||
<tr class="separator:gac62caac6baddd276a9569b3630fd47bf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#ga8c25ad5eee2386d7f5180ccaa0523246">rgbColor</a> (detail::tvec3< T, P > const &hsvValue)</td></tr>
|
||||
<tr class="separator:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad616175dd13cffd581c1bc30c8e3f904"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gad616175dd13cffd581c1bc30c8e3f904"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gad616175dd13cffd581c1bc30c8e3f904">saturation</a> (T const s)</td></tr>
|
||||
<tr class="separator:gad616175dd13cffd581c1bc30c8e3f904"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#ga7cd62eb3794fa48b192dbf655e37ea94">saturation</a> (T const s, detail::tvec3< T, P > const &color)</td></tr>
|
||||
<tr class="separator:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae192fb7020b374297e54ae12dda1c478"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gae192fb7020b374297e54ae12dda1c478"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gae192fb7020b374297e54ae12dda1c478">saturation</a> (T const s, detail::tvec4< T, P > const &color)</td></tr>
|
||||
<tr class="separator:gae192fb7020b374297e54ae12dda1c478"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#ga74aa7c7462245d83bd5a9edf9c6c2d91">isdenormal</a> (genType const &x)</td></tr>
|
||||
<tr class="separator:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Related to RGB to HSV conversions and operations. </p>
|
||||
<p><<a class="el" href="a00014.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/color_space.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<p>Provide functions to increase the compatibility with Cg and HLSL languages. </p>
|
||||
<p><<a class="el" href="a00014.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/common.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gaef4a1b7ed5bec43e245cd152951ec28a"></a>
|
||||
<a class="anchor" id="ga74aa7c7462245d83bd5a9edf9c6c2d91"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec3<T, P> glm::hsvColor </td>
|
||||
<td class="memname">GLM_FUNC_DECL genType::bool_type glm::isdenormal </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">detail::tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>rgbValue</em></td><td>)</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Converts a color from RGB color space to its color in HSV color space. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac62caac6baddd276a9569b3630fd47bf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::luminosity </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">detail::tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>color</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8c25ad5eee2386d7f5180ccaa0523246"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec3<T, P> glm::rgbColor </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">detail::tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>hsvValue</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Converts a color from HSV color space to its color in RGB color space. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gad616175dd13cffd581c1bc30c8e3f904"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tmat4x4<T, P> glm::saturation </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>s</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Build a saturation matrix. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga7cd62eb3794fa48b192dbf655e37ea94"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec3<T, P> glm::saturation </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>s</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">detail::tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>color</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Modify the saturation of a color. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gae192fb7020b374297e54ae12dda1c478"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec4<T, P> glm::saturation </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>s</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">detail::tvec4< T, P > const & </td>
|
||||
<td class="paramname"><em>color</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Modify the saturation of a color. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
|
||||
<p>Returns true if x is a denormalized number Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format. </p>
|
||||
<p>This format is less precise but can represent values closer to zero.</p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/isnan.xml">GLSL isnan man page</a> </dd>
|
||||
<dd>
|
||||
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -209,7 +86,7 @@ Functions</h2></td></tr>
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.5
|
||||
</a> 1.8.8
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user