glm/doc/api/a00156.html

533 lines
28 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2012-11-18 13:05:52 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2014-11-25 00:28:32 +00:00
<meta name="generator" content="Doxygen 1.8.8"/>
2014-11-30 20:57:58 +00:00
<title>0.9.6: Angle and Trigonometry Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2012-11-18 13:05:52 +00:00
<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>
2012-11-18 13:05:52 +00:00
<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;">
2014-11-25 00:28:32 +00:00
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
2013-12-25 22:48:55 +00:00
<td style="padding-left: 0.5em;">
2014-11-25 00:28:32 +00:00
<div id="projectname">0.9.6
2013-12-25 22:48:55 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
2012-11-18 13:05:52 +00:00
<!-- end header part -->
2014-11-25 00:28:32 +00:00
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2012-11-18 13:05:52 +00:00
</div><!-- top -->
<div class="header">
2013-12-25 22:48:55 +00:00
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2014-11-30 20:57:58 +00:00
<div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00160.html">GLM Core</a></div></div> </div>
2013-12-25 22:48:55 +00:00
</div><!--header-->
<div class="contents">
2013-12-25 22:48:55 +00:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
2014-11-30 20:57:58 +00:00
<tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga58ad259b788528fe0a4bd2eeb5e381cc">acos</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga3f368ad3e1883b60748ca2634d816104">acosh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga3f368ad3e1883b60748ca2634d816104"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga88e29b8289e882859d76a25798dd9490">asin</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga88e29b8289e882859d76a25798dd9490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga72bf44c1984e1afb63acf821ba33cac7">asinh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga461e769acb8b8cb695a5a89334546611">atan</a> (vecType&lt; T, P &gt; const &amp;y, vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga461e769acb8b8cb695a5a89334546611"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a> (vecType&lt; T, P &gt; const &amp;y_over_x)</td></tr>
<tr class="separator:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gaffa8decdd8620759f4e6fe4834768b87">atanh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:gaffa8decdd8620759f4e6fe4834768b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga728fd86f14609e37d83f82429995b7b3">cos</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:ga728fd86f14609e37d83f82429995b7b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga660582a4e5e843b6c1cd535777e8c295">cosh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:ga660582a4e5e843b6c1cd535777e8c295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga402144a18234e642b702bf585599b46d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga402144a18234e642b702bf585599b46d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga402144a18234e642b702bf585599b46d">degrees</a> (vecType&lt; T, P &gt; const &amp;radians)</td></tr>
<tr class="separator:ga402144a18234e642b702bf585599b46d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga0fd3ad793538521f76fa30db7f6edfed">radians</a> (vecType&lt; T, P &gt; const &amp;degrees)</td></tr>
<tr class="separator:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">sin</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gad8f89c12efe6f8d3ae8046625b266254">sinh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:gad8f89c12efe6f8d3ae8046625b266254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gab3ae890c38b7d3aa4d5e00998fd296b2">tan</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga234e904a0075f88654a594b5f837711f">tanh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
<tr class="separator:ga234e904a0075f88654a594b5f837711f"><td class="memSeparator" colspan="2">&#160;</td></tr>
2013-12-25 22:48:55 +00:00
</table>
2012-11-18 13:05:52 +00:00
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<h2 class="groupheader">Function Documentation</h2>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga58ad259b788528fe0a4bd2eeb5e381cc"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acos </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga3f368ad3e1883b60748ca2634d816104"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acosh </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga88e29b8289e882859d76a25798dd9490"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asin </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga72bf44c1984e1afb63acf821ba33cac7"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asinh </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga461e769acb8b8cb695a5a89334546611"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; 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>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="a00015_source.html#l00083">glm::atan2()</a>.</p>
</div>
</div>
<a class="anchor" id="gae8f22458bba8f2321ceb1bfc4a543216"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; 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="gaffa8decdd8620759f4e6fe4834768b87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atanh </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; 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="ga728fd86f14609e37d83f82429995b7b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cos </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga660582a4e5e843b6c1cd535777e8c295"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cosh </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
2013-12-25 22:48:55 +00:00
</tr>
2014-11-25 00:28:32 +00:00
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga402144a18234e642b702bf585599b46d"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2013-12-25 22:48:55 +00:00
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::degrees </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>radians</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
2014-11-25 00:28:32 +00:00
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga0fd3ad793538521f76fa30db7f6edfed"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2013-12-25 22:48:55 +00:00
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::radians </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>degrees</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga4a0ddceb6b1e64ce0e4da209dcb021d5"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sin </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gad8f89c12efe6f8d3ae8046625b266254"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sinh </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gab3ae890c38b7d3aa4d5e00998fd296b2"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tan </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga234e904a0075f88654a594b5f837711f"></a>
2013-12-25 22:48:55 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tanh </td>
2013-12-25 22:48:55 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>angle</em></td><td>)</td>
2013-12-25 22:48:55 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2013-12-25 22:48:55 +00:00
</div>
</div>
2012-11-18 13:05:52 +00:00
</div><!-- contents -->
<!-- start footer part -->
<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"/>
2014-11-25 00:28:32 +00:00
</a> 1.8.8
</small></address>
</body>
</html>