Updated documentation
This commit is contained in:
Christophe Riccio
@@ -2,130 +2,74 @@
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
|
||||
<title>GLM_GTX_fast_trigonometry: Fast trigonometric functions</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>GLM_GTX_extend</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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_fast_trigonometry: Fast trigonometric functions</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
||||
<div class="title">GLM_GTX_extend</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#ga33b609e0abf9c38548d4381d0540b95b">fastAcos</a> (const T &angle)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gabe1e89bd95ee266f0f6b02e11f0f122c">fastAsin</a> (const T &angle)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gaa788571fc615b131e96c66df01b10e36">fastAtan</a> (const T &y, const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gab6f0c71fbd1c4cd4c3e4992f3656178f">fastAtan</a> (const T &angle)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gada306b7a16a4e230c28ea0764b325ef0">fastCos</a> (const T &angle)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#ga8069d4fb062dc17d93183946cdb3bf3a">fastSin</a> (const T &angle)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gaf9f4798ceb6e0fc0b67bfcab836f0288">fastTan</a> (const T &angle)</td></tr>
|
||||
<tr class="memitem:gabb68ca9fb290f499da24515735397550"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gabb68ca9fb290f499da24515735397550"><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00169.html#gabb68ca9fb290f499da24515735397550">extend</a> (genType const &Origin, genType const &Source, typename genType::value_type const Length)</td></tr>
|
||||
<tr class="separator:gabb68ca9fb290f499da24515735397550"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Fast but less accurate implementations of trigonometric functions. </p>
|
||||
<p><<a class="el" href="a00025.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/fast_trigonometry.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="ga33b609e0abf9c38548d4381d0540b95b"></a><!-- doxytag: member="glm::fastAcos" ref="ga33b609e0abf9c38548d4381d0540b95b" args="(const T &angle)" -->
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Extend a position from a source to a position at a defined length. </p>
|
||||
<p><<a class="el" href="a00021.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/extend.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gabb68ca9fb290f499da24515735397550"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastAcos </td>
|
||||
<td class="memname">genType glm::extend </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common acos function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gabe1e89bd95ee266f0f6b02e11f0f122c"></a><!-- doxytag: member="glm::fastAsin" ref="gabe1e89bd95ee266f0f6b02e11f0f122c" args="(const T &angle)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastAsin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common asin function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa788571fc615b131e96c66df01b10e36"></a><!-- doxytag: member="glm::fastAtan" ref="gaa788571fc615b131e96c66df01b10e36" args="(const T &y, const T &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastAtan </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>y</em>, </td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Origin</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em> </td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Source</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">typename genType::value_type const </td>
|
||||
<td class="paramname"><em>Length</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -133,102 +77,19 @@ Functions</h2></td></tr>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Faster than the common atan function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
<p>Extends of Length the Origin position using the (Source - Origin) direction. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00169.html" title="Extend a position from a source to a position at a defined length.">GLM_GTX_extend</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab6f0c71fbd1c4cd4c3e4992f3656178f"></a><!-- doxytag: member="glm::fastAtan" ref="gab6f0c71fbd1c4cd4c3e4992f3656178f" args="(const T &angle)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastAtan </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common atan function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gada306b7a16a4e230c28ea0764b325ef0"></a><!-- doxytag: member="glm::fastCos" ref="gada306b7a16a4e230c28ea0764b325ef0" args="(const T &angle)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastCos </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common cos function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8069d4fb062dc17d93183946cdb3bf3a"></a><!-- doxytag: member="glm::fastSin" ref="ga8069d4fb062dc17d93183946cdb3bf3a" args="(const T &angle)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastSin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common sin function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaf9f4798ceb6e0fc0b67bfcab836f0288"></a><!-- doxytag: member="glm::fastTan" ref="gaf9f4798ceb6e0fc0b67bfcab836f0288" args="(const T &angle)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastTan </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>angle</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common tan function but less accurate. </p>
|
||||
<p>Defined between -2pi and 2pi. From GLM_GTX_fast_trigonometry extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user