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

220
doc/api/a00173.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_fast_trigonometry</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTC_matrix_access</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,90 +41,78 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_fast_trigonometry</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTC_matrix_access<div class="ingroups"><a class="el" href="a00164.html">GTC Extensions (Stable)</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:ga33b609e0abf9c38548d4381d0540b95b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga33b609e0abf9c38548d4381d0540b95b"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga33b609e0abf9c38548d4381d0540b95b">fastAcos</a> (const T &amp;angle)</td></tr>
<tr class="separator:ga33b609e0abf9c38548d4381d0540b95b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe1e89bd95ee266f0f6b02e11f0f122c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gabe1e89bd95ee266f0f6b02e11f0f122c"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gabe1e89bd95ee266f0f6b02e11f0f122c">fastAsin</a> (const T &amp;angle)</td></tr>
<tr class="separator:gabe1e89bd95ee266f0f6b02e11f0f122c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa788571fc615b131e96c66df01b10e36"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaa788571fc615b131e96c66df01b10e36"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaa788571fc615b131e96c66df01b10e36">fastAtan</a> (const T &amp;y, const T &amp;x)</td></tr>
<tr class="separator:gaa788571fc615b131e96c66df01b10e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6f0c71fbd1c4cd4c3e4992f3656178f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gab6f0c71fbd1c4cd4c3e4992f3656178f"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gab6f0c71fbd1c4cd4c3e4992f3656178f">fastAtan</a> (const T &amp;angle)</td></tr>
<tr class="separator:gab6f0c71fbd1c4cd4c3e4992f3656178f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada306b7a16a4e230c28ea0764b325ef0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gada306b7a16a4e230c28ea0764b325ef0"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gada306b7a16a4e230c28ea0764b325ef0">fastCos</a> (const T &amp;angle)</td></tr>
<tr class="separator:gada306b7a16a4e230c28ea0764b325ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8069d4fb062dc17d93183946cdb3bf3a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga8069d4fb062dc17d93183946cdb3bf3a"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga8069d4fb062dc17d93183946cdb3bf3a">fastSin</a> (const T &amp;angle)</td></tr>
<tr class="separator:ga8069d4fb062dc17d93183946cdb3bf3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9f4798ceb6e0fc0b67bfcab836f0288"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaf9f4798ceb6e0fc0b67bfcab836f0288"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaf9f4798ceb6e0fc0b67bfcab836f0288">fastTan</a> (const T &amp;angle)</td></tr>
<tr class="separator:gaf9f4798ceb6e0fc0b67bfcab836f0288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafeb75b82cc45bf9e68d3050eea093aa7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gafeb75b82cc45bf9e68d3050eea093aa7"><td class="memTemplItemLeft" align="right" valign="top">genType::col_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gafeb75b82cc45bf9e68d3050eea093aa7">column</a> (genType const &amp;m, length_t const &amp;index)</td></tr>
<tr class="separator:gafeb75b82cc45bf9e68d3050eea093aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga113d7e630822cceecd1f312657fde7f5"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga113d7e630822cceecd1f312657fde7f5"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga113d7e630822cceecd1f312657fde7f5">column</a> (genType const &amp;m, length_t const &amp;index, typename genType::col_type const &amp;x)</td></tr>
<tr class="separator:ga113d7e630822cceecd1f312657fde7f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5af815e1ea261465434a6f8fae88af1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gad5af815e1ea261465434a6f8fae88af1"><td class="memTemplItemLeft" align="right" valign="top">genType::row_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gad5af815e1ea261465434a6f8fae88af1">row</a> (genType const &amp;m, length_t const &amp;index)</td></tr>
<tr class="separator:gad5af815e1ea261465434a6f8fae88af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc6901bdd6e36c522228611e765cf3a1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gacc6901bdd6e36c522228611e765cf3a1"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gacc6901bdd6e36c522228611e765cf3a1">row</a> (genType const &amp;m, length_t const &amp;index, typename genType::row_type const &amp;x)</td></tr>
<tr class="separator:gacc6901bdd6e36c522228611e765cf3a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Fast but less accurate implementations of trigonometric functions. </p>
<p>&lt;<a class="el" href="a00025.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/fast_trigonometry.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Defines functions to access rows or columns of a matrix easily. </p>
<p>&lt;<a class="el" href="a00072.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/matrix_access.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga33b609e0abf9c38548d4381d0540b95b"></a>
<a class="anchor" id="gafeb75b82cc45bf9e68d3050eea093aa7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastAcos </td>
<td class="memname">genType::col_type glm::column </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastAsin </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastAtan </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramtype">length_t const &amp;&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a specific column of a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00173.html" title="Defines functions to access rows or columns of a matrix easily. ">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga113d7e630822cceecd1f312657fde7f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::column </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">length_t const &amp;&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::col_type const &amp;&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
@@ -129,84 +123,72 @@ Functions</h2></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>
<p>Set a specific column to a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00173.html" title="Defines functions to access rows or columns of a matrix easily. ">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab6f0c71fbd1c4cd4c3e4992f3656178f"></a>
<a class="anchor" id="gad5af815e1ea261465434a6f8fae88af1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastAtan </td>
<td class="memname">genType::row_type glm::row </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">length_t const &amp;&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>
<p>Get a specific row of a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00173.html" title="Defines functions to access rows or columns of a matrix easily. ">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gada306b7a16a4e230c28ea0764b325ef0"></a>
<a class="anchor" id="gacc6901bdd6e36c522228611e765cf3a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastCos </td>
<td class="memname">genType glm::row </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastSin </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">length_t const &amp;&#160;</td>
<td class="paramname"><em>index</em>, </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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastTan </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::row_type const &amp;&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>
<p>Set a specific row to a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00173.html" title="Defines functions to access rows or columns of a matrix easily. ">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
@@ -215,7 +197,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>