Updated API documentation

This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 deletions

View File

@@ -4,7 +4,7 @@
<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.10"/>
<title>0.9.7: GLM_GTX_handed_coordinate_space</title>
<title>0.9.8: GLM_GTX_io</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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.7
<div id="projectname">0.9.8
</div>
</td>
</tr>
@@ -36,96 +36,14 @@
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_handed_coordinate_space<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_io<div class="ingroups"><a class="el" href="a00155.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: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="a00201.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="a00201.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>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="ga7425e0ebfe6a56919900a072ae1f8017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::leftHanded </td>
<td>(</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">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">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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="ga17cd83888de8755c0435c589fafd3603"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::rightHanded </td>
<td>(</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">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">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return if a trihedron right handed or not. </p>
<p>From GLM_GTX_handed_coordinate_space extension. </p>
</div>
</div>
<p>std::[w]ostream support for glm types </p>
<p>std::[w]ostream support for glm types + precision/width/etc. manipulators based on howard hinnant's std::chrono io proposal [<a href="http://home.roadrunner.com/~hinnant/bloomington/chrono_io.html">http://home.roadrunner.com/~hinnant/bloomington/chrono_io.html</a>]</p>
<p>&lt;<a class="el" href="a00048.html" title="GLM_GTX_io ">glm/gtx/io.hpp</a>&gt; needs to be included to use these functionalities. </p>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>