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_normalize_dot</title>
<title>0.9.8: GLM_GTX_perpendicular</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>
@@ -39,38 +39,35 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_normalize_dot<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_perpendicular<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:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00217.html#ga8593b21bc2fe22184f01d5e08b5a2024">fastNormalizeDot</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffbc2f2cb15838de8886a68048f9004d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gaffbc2f2cb15838de8886a68048f9004d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00217.html#gaffbc2f2cb15838de8886a68048f9004d">normalizeDot</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:gaffbc2f2cb15838de8886a68048f9004d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41f8c73da9798a18e6b1e32f1e301f07"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<tr class="memitem:ga41f8c73da9798a18e6b1e32f1e301f07"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00217.html#ga41f8c73da9798a18e6b1e32f1e301f07">perp</a> (vecType const &amp;x, vecType const &amp;Normal)</td></tr>
<tr class="separator:ga41f8c73da9798a18e6b1e32f1e301f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Dot product of vectors that need to be normalize with a single square root. </p>
<p>&lt;glm/gtx/normalized_dot.hpp&gt; need to be included to use these functionalities. </p>
<p>Perpendicular of a vector from other one. </p>
<p>&lt;<a class="el" href="a00083.html" title="GLM_GTX_perpendicular ">glm/gtx/perpendicular.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8593b21bc2fe22184f01d5e08b5a2024"></a>
<a class="anchor" id="ga41f8c73da9798a18e6b1e32f1e301f07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::fastNormalizeDot </td>
<td class="memname">GLM_FUNC_DECL vecType glm::perp </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -80,39 +77,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Normalize parameters and returns the dot product of x and y. </p>
<p>Faster that dot(fastNormalize(x), fastNormalize(y)).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00217.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="gaffbc2f2cb15838de8886a68048f9004d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::normalizeDot </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Normalize parameters and returns the dot product of x and y. </p>
<p>It's faster that dot(normalize(x), normalize(y)).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00217.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
<p>Projects x a perpendicular axis of Normal. </p>
<p>From GLM_GTX_perpendicular extension. </p>
</div>
</div>