mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
doc/api/a00196.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_polar_coordinates</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_fast_exponential</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>
@@ -15,18 +16,23 @@
<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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<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>
@@ -35,58 +41,188 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_polar_coordinates</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_fast_exponential<div class="ingroups"><a class="el" href="a00165.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:gab39f1cd88732cf9a6eaa6a8a885dddef"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gab39f1cd88732cf9a6eaa6a8a885dddef"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#gab39f1cd88732cf9a6eaa6a8a885dddef">euclidean</a> (detail::tvec3&lt; T &gt; const &amp;polar)</td></tr>
<tr class="separator:gab39f1cd88732cf9a6eaa6a8a885dddef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89025c86d0e2ee0a20f0cda440ea8ad5"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga89025c86d0e2ee0a20f0cda440ea8ad5"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga89025c86d0e2ee0a20f0cda440ea8ad5">polar</a> (detail::tvec3&lt; T &gt; const &amp;euclidean)</td></tr>
<tr class="separator:ga89025c86d0e2ee0a20f0cda440ea8ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81550f837781889cc21fe49852102ea0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga81550f837781889cc21fe49852102ea0"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga81550f837781889cc21fe49852102ea0">fastExp</a> (const T &amp;x)</td></tr>
<tr class="separator:ga81550f837781889cc21fe49852102ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga27ffd3d58db8a5309300f16cc5d9284c">fastExp2</a> (const T &amp;x)</td></tr>
<tr class="separator:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaddd4e635f1c3168122fe7b14753935b9"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaddd4e635f1c3168122fe7b14753935b9"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#gaddd4e635f1c3168122fe7b14753935b9">fastLn</a> (const T &amp;x)</td></tr>
<tr class="separator:gaddd4e635f1c3168122fe7b14753935b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga784a80d571f0f596d438863775827cd0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga784a80d571f0f596d438863775827cd0"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga784a80d571f0f596d438863775827cd0">fastLog</a> (const T &amp;x)</td></tr>
<tr class="separator:ga784a80d571f0f596d438863775827cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac516a11818384b9392412ac199044cf6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gac516a11818384b9392412ac199044cf6"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#gac516a11818384b9392412ac199044cf6">fastLog2</a> (const T &amp;x)</td></tr>
<tr class="separator:gac516a11818384b9392412ac199044cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ecbe429c87b820368f425ee8d22841a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga0ecbe429c87b820368f425ee8d22841a"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga0ecbe429c87b820368f425ee8d22841a">fastPow</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr class="separator:ga0ecbe429c87b820368f425ee8d22841a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga3afd7b7f1ac505ca9247dc6ffa0c25cb">fastPow</a> (genTypeT const &amp;x, genTypeU const &amp;y)</td></tr>
<tr class="separator:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Conversion from Euclidean space to polar space and revert. </p>
<p>&lt;<a class="el" href="a00074.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/polar_coordinates.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Fast but less accurate implementations of exponential based functions. </p>
<p>&lt;<a class="el" href="a00029.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/fast_exponential.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab39f1cd88732cf9a6eaa6a8a885dddef"></a>
<a class="anchor" id="ga81550f837781889cc21fe49852102ea0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::euclidean </td>
<td class="memname">T glm::fastExp </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>polar</em></td><td>)</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert Polar to Euclidean coordinates. </p>
<p>From GLM_GTX_polar_coordinates extension. </p>
<p>Faster than the common exp function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga89025c86d0e2ee0a20f0cda440ea8ad5"></a>
<a class="anchor" id="ga27ffd3d58db8a5309300f16cc5d9284c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::polar </td>
<td class="memname">T glm::fastExp2 </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>euclidean</em></td><td>)</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. </p>
<p>From GLM_GTX_polar_coordinates extension. </p>
<p>Faster than the common exp2 function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaddd4e635f1c3168122fe7b14753935b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLn </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common ln function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga784a80d571f0f596d438863775827cd0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLog </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common log function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac516a11818384b9392412ac199044cf6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLog2 </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common log2 function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0ecbe429c87b820368f425ee8d22841a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::fastPow </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType 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>Faster than the common pow function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3afd7b7f1ac505ca9247dc6ffa0c25cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::fastPow </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU 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>Faster than the common pow function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
@@ -95,7 +231,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.2
</a> 1.8.5
</small></address>
</body>
</html>