Updated API

This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 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.8"/>
<title>0.9.6: GLM_GTX_optimum_pow</title>
<title>0.9.6: 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>
@@ -39,167 +39,46 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_optimum_pow<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_perpendicular<div class="ingroups"><a class="el" href="a00159.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:gad18baedb0f3eaea4b4544771e19574f5"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gad18baedb0f3eaea4b4544771e19574f5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#gad18baedb0f3eaea4b4544771e19574f5">pow2</a> (const genType &amp;x)</td></tr>
<tr class="separator:gad18baedb0f3eaea4b4544771e19574f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga47dbbd973d7ad8be1b135d57281e16cf"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga47dbbd973d7ad8be1b135d57281e16cf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga47dbbd973d7ad8be1b135d57281e16cf">pow3</a> (const genType &amp;x)</td></tr>
<tr class="separator:ga47dbbd973d7ad8be1b135d57281e16cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabae007bac8e442a2601db03de5827107"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gabae007bac8e442a2601db03de5827107"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#gabae007bac8e442a2601db03de5827107">pow4</a> (const genType &amp;x)</td></tr>
<tr class="separator:gabae007bac8e442a2601db03de5827107"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga399b24df28267c1f061c462dd359affd"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00218.html#ga399b24df28267c1f061c462dd359affd">powOfTwo</a> (int num)</td></tr>
<tr class="separator:ga399b24df28267c1f061c462dd359affd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d6077d83402b69c6a44208f77f8f7cd"><td class="memTemplParams" colspan="2">template&lt;precision P&gt; </td></tr>
<tr class="memitem:ga5d6077d83402b69c6a44208f77f8f7cd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga5d6077d83402b69c6a44208f77f8f7cd">powOfTwo</a> (tvec2&lt; int, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga5d6077d83402b69c6a44208f77f8f7cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga549473446b618447a3504c15c1e2c2d0"><td class="memTemplParams" colspan="2">template&lt;precision P&gt; </td></tr>
<tr class="memitem:ga549473446b618447a3504c15c1e2c2d0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga549473446b618447a3504c15c1e2c2d0">powOfTwo</a> (tvec3&lt; int, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga549473446b618447a3504c15c1e2c2d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3505315881732f38f68192fddb7f2971"><td class="memTemplParams" colspan="2">template&lt;precision P&gt; </td></tr>
<tr class="memitem:ga3505315881732f38f68192fddb7f2971"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec4&lt; bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga3505315881732f38f68192fddb7f2971">powOfTwo</a> (tvec4&lt; int, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga3505315881732f38f68192fddb7f2971"><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="a00218.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>Integer exponentiation of power functions. </p>
<p>&lt;<a class="el" href="a00085.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/optimum_pow.hpp</a>&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="a00089.html" title="OpenGL Mathematics (glm.g-truc.net) ">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="gad18baedb0f3eaea4b4544771e19574f5"></a>
<a class="anchor" id="ga41f8c73da9798a18e6b1e32f1e301f07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow2 </td>
<td class="memname">GLM_FUNC_DECL vecType glm::perp </td>
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns x raised to the power of 2. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="ga47dbbd973d7ad8be1b135d57281e16cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow3 </td>
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>&#160;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns x raised to the power of 3. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="gabae007bac8e442a2601db03de5827107"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow4 </td>
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns x raised to the power of 4. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="ga399b24df28267c1f061c462dd359affd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::gtx::powOfTwo </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the parameter is a power of 2 number. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="ga5d6077d83402b69c6a44208f77f8f7cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec2&lt;bool, P&gt; glm::gtx::powOfTwo </td>
<td>(</td>
<td class="paramtype">tvec2&lt; int, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="ga549473446b618447a3504c15c1e2c2d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec3&lt;bool, P&gt; glm::gtx::powOfTwo </td>
<td>(</td>
<td class="paramtype">tvec3&lt; int, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
<a class="anchor" id="ga3505315881732f38f68192fddb7f2971"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec4&lt;bool, P&gt; glm::gtx::powOfTwo </td>
<td>(</td>
<td class="paramtype">tvec4&lt; int, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
<p>Projects x a perpendicular axis of Normal. </p>
<p>From GLM_GTX_perpendicular extension. </p>
</div>
</div>