Updated doxygen for 0.9.6 API

This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions

View File

@@ -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_gradient_paint</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: GLM_GTX_handed_coordinate_space</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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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,44 +39,44 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_gradient_paint<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_handed_coordinate_space<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:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#gab2d6e851946cd10ea42e75d64dbcdfc7">linearGradient</a> (detail::tvec2&lt; T, P &gt; const &amp;Point0, detail::tvec2&lt; T, P &gt; const &amp;Point1, detail::tvec2&lt; T, P &gt; const &amp;Position)</td></tr>
<tr class="separator:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#ga0b1e049844c0627a03907d4a8bcde13f">radialGradient</a> (detail::tvec2&lt; T, P &gt; const &amp;Center, T const &amp;Radius, detail::tvec2&lt; T, P &gt; const &amp;Focal, detail::tvec2&lt; T, P &gt; const &amp;Position)</td></tr>
<tr class="separator:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7425e0ebfe6a56919900a072ae1f8017"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga7425e0ebfe6a56919900a072ae1f8017"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#ga7425e0ebfe6a56919900a072ae1f8017">leftHanded</a> (tvec3&lt; T, P &gt; const &amp;tangent, tvec3&lt; T, P &gt; const &amp;binormal, tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:ga7425e0ebfe6a56919900a072ae1f8017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17cd83888de8755c0435c589fafd3603"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga17cd83888de8755c0435c589fafd3603"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#ga17cd83888de8755c0435c589fafd3603">rightHanded</a> (tvec3&lt; T, P &gt; const &amp;tangent, tvec3&lt; T, P &gt; const &amp;binormal, tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:ga17cd83888de8755c0435c589fafd3603"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions that return the color of procedural gradient for specific coordinates. </p>
<p>&lt;<a class="el" href="a00044.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/gradient_paint.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>To know if a set of three basis vectors defines a right or left-handed coordinate system. </p>
<p>&lt;glm/gtx/handed_coordinate_system.hpp&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab2d6e851946cd10ea42e75d64dbcdfc7"></a>
<a class="anchor" id="ga7425e0ebfe6a56919900a072ae1f8017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::linearGradient </td>
<td class="memname">GLM_FUNC_DECL bool glm::leftHanded </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point0</em>, </td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>tangent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point1</em>, </td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>binormal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Position</em>&#160;</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -88,38 +86,32 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a color from a linear gradient. </p>
<dl class="section see"><dt>See Also</dt><dd>- <a class="el" href="a00199.html" title="Functions that return the color of procedural gradient for specific coordinates. ">GLM_GTX_gradient_paint</a> </dd></dl>
<p>Return if a trihedron left handed or not. </p>
<p>From GLM_GTX_handed_coordinate_space extension. </p>
</div>
</div>
<a class="anchor" id="ga0b1e049844c0627a03907d4a8bcde13f"></a>
<a class="anchor" id="ga17cd83888de8755c0435c589fafd3603"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::radialGradient </td>
<td class="memname">GLM_FUNC_DECL bool glm::rightHanded </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Center</em>, </td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>tangent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>Radius</em>, </td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>binormal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Focal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Position</em>&#160;</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -129,8 +121,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a color from a radial gradient. </p>
<dl class="section see"><dt>See Also</dt><dd>- <a class="el" href="a00199.html" title="Functions that return the color of procedural gradient for specific coordinates. ">GLM_GTX_gradient_paint</a> </dd></dl>
<p>Return if a trihedron right handed or not. </p>
<p>From GLM_GTX_handed_coordinate_space extension. </p>
</div>
</div>
@@ -139,7 +131,7 @@ Functions</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>