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

489
doc/api/a00162.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_closest_point</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: Angle and Trigonometry Functions</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,41 +41,189 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_closest_point</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00167.html">GLM Core</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:ga737bd08d425540f365db4694fb552b8b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga737bd08d425540f365db4694fb552b8b"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga737bd08d425540f365db4694fb552b8b">closestPointOnLine</a> (detail::tvec3&lt; T &gt; const &amp;point, detail::tvec3&lt; T &gt; const &amp;a, detail::tvec3&lt; T &gt; const &amp;b)</td></tr>
<tr class="separator:ga737bd08d425540f365db4694fb552b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gac85497ed2e39d4cac4ac32bed4dfc506">acos</a> (genType const &amp;x)</td></tr>
<tr class="separator:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga961d72b4a20d09d6e71fdf076ad4f433">acosh</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafca5e8c71ea06be0840227b4aafc5680"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gafca5e8c71ea06be0840227b4aafc5680"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gafca5e8c71ea06be0840227b4aafc5680">asin</a> (genType const &amp;x)</td></tr>
<tr class="separator:gafca5e8c71ea06be0840227b4aafc5680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa52acc1218a5ddd0f8d94fcd098685b1">asinh</a> (genType const &amp;x)</td></tr>
<tr class="separator:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gabf80ac0817d1db032dd6a0969aa2b84a">atan</a> (genType const &amp;y, genType const &amp;x)</td></tr>
<tr class="separator:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa7be96f0c12a40eeac5c7f04a3d465a1">atan</a> (genType const &amp;y_over_x)</td></tr>
<tr class="separator:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa20b78cb9c12e30bd5a3054b8cb3d099">atanh</a> (genType const &amp;x)</td></tr>
<tr class="separator:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac6708d4f0895dc79b65f50db00840167"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac6708d4f0895dc79b65f50db00840167"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gac6708d4f0895dc79b65f50db00840167">cos</a> (genType const &amp;angle)</td></tr>
<tr class="separator:gac6708d4f0895dc79b65f50db00840167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa7685634f6e920ba9a683e5ec7aed976">cosh</a> (genType const &amp;angle)</td></tr>
<tr class="separator:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaf4e5661bd1c993f6090d49e988a4c78a">degrees</a> (genType const &amp;radians)</td></tr>
<tr class="separator:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga431d31cdb060059bc5b0696e212f1453"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga431d31cdb060059bc5b0696e212f1453"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga431d31cdb060059bc5b0696e212f1453">radians</a> (genType const &amp;degrees)</td></tr>
<tr class="separator:ga431d31cdb060059bc5b0696e212f1453"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gafbab21016b7f3bc21afb09a7e42e2df1">sin</a> (genType const &amp;angle)</td></tr>
<tr class="separator:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e8c9a896e803661058de83429aa6eda"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga2e8c9a896e803661058de83429aa6eda"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga2e8c9a896e803661058de83429aa6eda">sinh</a> (genType const &amp;angle)</td></tr>
<tr class="separator:ga2e8c9a896e803661058de83429aa6eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga328aeb0de4f312dc3d200cb929715d44"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga328aeb0de4f312dc3d200cb929715d44"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga328aeb0de4f312dc3d200cb929715d44">tan</a> (genType const &amp;angle)</td></tr>
<tr class="separator:ga328aeb0de4f312dc3d200cb929715d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga941f20e5315113d1a2e037f073a62f04"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga941f20e5315113d1a2e037f073a62f04"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga941f20e5315113d1a2e037f073a62f04">tanh</a> (genType const &amp;angle)</td></tr>
<tr class="separator:ga941f20e5315113d1a2e037f073a62f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Find the point on a straight line which is the closet of a point. </p>
<p>&lt;<a class="el" href="a00009_source.html">glm/gtx/closest_point.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Function parameters specified as angle are assumed to be in units of radians. </p>
<p>In no case will any of these functions result in a divide by zero error. If the divisor of a ratio is 0, then results will be undefined.</p>
<p>These all operate component-wise. The description is per component. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga737bd08d425540f365db4694fb552b8b"></a>
<a class="anchor" id="gac85497ed2e39d4cac4ac32bed4dfc506"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::closestPointOnLine </td>
<td class="memname">GLM_FUNC_DECL genType glm::acos </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>point</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc cosine. </p>
<p>Returns an angle whose sine is x. The range of values returned by this function is [0, PI]. Results are undefined if |x| &gt; 1.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/acos.xml">GLSL acos man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga961d72b4a20d09d6e71fdf076ad4f433"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::acosh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p>
<p>Results are undefined if x &lt; 1.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/acosh.xml">GLSL acosh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafca5e8c71ea06be0840227b4aafc5680"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::asin </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc sine. </p>
<p>Returns an angle whose sine is x. The range of values returned by this function is [-PI/2, PI/2]. Results are undefined if |x| &gt; 1.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/asin.xml">GLSL asin man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa52acc1218a5ddd0f8d94fcd098685b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::asinh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc hyperbolic sine; returns the inverse of sinh. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/asinh.xml">GLSL asinh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gabf80ac0817d1db032dd6a0969aa2b84a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::atan </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -79,8 +233,293 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Find the point on a straight line which is the closet of a point. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00162.html" title="Find the point on a straight line which is the closet of a point.">GLM_GTX_closest_point</a> </dd></dl>
<p>Arc tangent. </p>
<p>Returns an angle whose tangent is y/x. The signs of x and y are used to determine what quadrant the angle is in. The range of values returned by this function is [-PI, PI]. Results are undefined if x and y are both 0.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atan.xml">GLSL atan man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
<p>Referenced by <a class="el" href="a00017_source.html#l00080">glm::atan2()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa7be96f0c12a40eeac5c7f04a3d465a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::atan </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>y_over_x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc tangent. </p>
<p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atan.xml">GLSL atan man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa20b78cb9c12e30bd5a3054b8cb3d099"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::atanh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
<p>Results are undefined if abs(x) &gt;= 1.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atanh.xml">GLSL atanh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac6708d4f0895dc79b65f50db00840167"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::cos </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The standard trigonometric cosine function. </p>
<p>The values returned by this function will range from [-1, 1].</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cos.xml">GLSL cos man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa7685634f6e920ba9a683e5ec7aed976"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::cosh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cosh.xml">GLSL cosh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf4e5661bd1c993f6090d49e988a4c78a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::degrees </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>radians</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts radians to degrees and returns the result. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/degrees.xml">GLSL degrees man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga431d31cdb060059bc5b0696e212f1453"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::radians </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>degrees</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts degrees to radians and returns the result. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/radians.xml">GLSL radians man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafbab21016b7f3bc21afb09a7e42e2df1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::sin </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The standard trigonometric sine function. </p>
<p>The values returned by this function will range from [-1, 1].</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sin.xml">GLSL sin man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2e8c9a896e803661058de83429aa6eda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::sinh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sinh.xml">GLSL sinh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga328aeb0de4f312dc3d200cb929715d44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::tan </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The standard trigonometric tangent function. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/tan.xml">GLSL tan man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga941f20e5315113d1a2e037f073a62f04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::tanh </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/tanh.xml">GLSL tanh man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
</div>
</div>
@@ -89,7 +528,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>