glm/doc/api/a00038_source.html
Christophe Riccio a7b72ec5b2 Updated API doc
2017-08-15 21:22:51 +02:00

174 lines
20 KiB
HTML

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>0.9.9 API documenation: func_trigonometric.hpp Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.9 API documenation
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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 class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_da256b9dd32ba43e2eaa8a2832c37f1b.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">func_trigonometric.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00038.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00102.html">setup.hpp</a>&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00090.html">qualifier.hpp</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga3c52efaefd061d714c9416db7baffb52">radians</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00154.html#ga3d8b6a92957633fa63f9e9a1761cfb01">degrees</a>);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga3d8b6a92957633fa63f9e9a1761cfb01">degrees</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00154.html#ga3c52efaefd061d714c9416db7baffb52">radians</a>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gace40403215c8fbdcfcb71d0ee7f754c5">sin</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga25e0c5534cb5ca943767bccb5df37757">cos</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga9a95d48ea582becb340c5800427ec89d">tan</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gaa856f3bc6f9b04b48b5aa1394cdc570a">asin</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga7fc0edab37382bccace71b13efd94023">acos</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga9ffac8e7b1194cb5cbac7009c012062f">atan</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga9ffac8e7b1194cb5cbac7009c012062f">atan</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y_over_x);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gaa11ee703574f57880f7d60bc02b54812">sinh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gaadd9cd03c7e505952b8f0a0ac97388de">cosh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gabf113eb464891c35243b3bdea8610c56">tanh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga0b15003df346e23a7f1db7de4453ef6f">asinh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#gadec1dc94c7c9c054b1cae921f65c67a6">acosh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00154.html#ga10f80a2b7bac23f556ad09c8711be5fd">atanh</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="preprocessor">#include &quot;func_trigonometric.inl&quot;</span></div>
<div class="ttc" id="a00154_html_gadec1dc94c7c9c054b1cae921f65c67a6"><div class="ttname"><a href="a00154.html#gadec1dc94c7c9c054b1cae921f65c67a6">glm::acosh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; acosh(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic cosine; returns the non-negative inverse of cosh. </div></div>
<div class="ttc" id="a00154_html_ga10f80a2b7bac23f556ad09c8711be5fd"><div class="ttname"><a href="a00154.html#ga10f80a2b7bac23f556ad09c8711be5fd">glm::atanh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; atanh(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic tangent; returns the inverse of tanh. </div></div>
<div class="ttc" id="a00154_html_gaa856f3bc6f9b04b48b5aa1394cdc570a"><div class="ttname"><a href="a00154.html#gaa856f3bc6f9b04b48b5aa1394cdc570a">glm::asin</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; asin(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Arc sine. </div></div>
<div class="ttc" id="a00154_html_gaadd9cd03c7e505952b8f0a0ac97388de"><div class="ttname"><a href="a00154.html#gaadd9cd03c7e505952b8f0a0ac97388de">glm::cosh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; cosh(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </div></div>
<div class="ttc" id="a00154_html_ga0b15003df346e23a7f1db7de4453ef6f"><div class="ttname"><a href="a00154.html#ga0b15003df346e23a7f1db7de4453ef6f">glm::asinh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; asinh(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic sine; returns the inverse of sinh. </div></div>
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
<div class="ttc" id="a00154_html_ga3d8b6a92957633fa63f9e9a1761cfb01"><div class="ttname"><a href="a00154.html#ga3d8b6a92957633fa63f9e9a1761cfb01">glm::degrees</a></div><div class="ttdeci">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; L, T, P &gt; degrees(vec&lt; L, T, P &gt; const &amp;radians)</div><div class="ttdoc">Converts radians to degrees and returns the result. </div></div>
<div class="ttc" id="a00154_html_gabf113eb464891c35243b3bdea8610c56"><div class="ttname"><a href="a00154.html#gabf113eb464891c35243b3bdea8610c56">glm::tanh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; tanh(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </div></div>
<div class="ttc" id="a00154_html_ga9ffac8e7b1194cb5cbac7009c012062f"><div class="ttname"><a href="a00154.html#ga9ffac8e7b1194cb5cbac7009c012062f">glm::atan</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; atan(vec&lt; L, T, P &gt; const &amp;y_over_x)</div><div class="ttdoc">Arc tangent. </div></div>
<div class="ttc" id="a00090_html"><div class="ttname"><a href="a00090.html">qualifier.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00174_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
<div class="ttc" id="a00154_html_ga7fc0edab37382bccace71b13efd94023"><div class="ttname"><a href="a00154.html#ga7fc0edab37382bccace71b13efd94023">glm::acos</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; acos(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Arc cosine. </div></div>
<div class="ttc" id="a00154_html_ga9a95d48ea582becb340c5800427ec89d"><div class="ttname"><a href="a00154.html#ga9a95d48ea582becb340c5800427ec89d">glm::tan</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; tan(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric tangent function. </div></div>
<div class="ttc" id="a00154_html_ga3c52efaefd061d714c9416db7baffb52"><div class="ttname"><a href="a00154.html#ga3c52efaefd061d714c9416db7baffb52">glm::radians</a></div><div class="ttdeci">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; L, T, P &gt; radians(vec&lt; L, T, P &gt; const &amp;degrees)</div><div class="ttdoc">Converts degrees to radians and returns the result. </div></div>
<div class="ttc" id="a00154_html_ga25e0c5534cb5ca943767bccb5df37757"><div class="ttname"><a href="a00154.html#ga25e0c5534cb5ca943767bccb5df37757">glm::cos</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; cos(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric cosine function. </div></div>
<div class="ttc" id="a00154_html_gaa11ee703574f57880f7d60bc02b54812"><div class="ttname"><a href="a00154.html#gaa11ee703574f57880f7d60bc02b54812">glm::sinh</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; sinh(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </div></div>
<div class="ttc" id="a00154_html_gace40403215c8fbdcfcb71d0ee7f754c5"><div class="ttname"><a href="a00154.html#gace40403215c8fbdcfcb71d0ee7f754c5">glm::sin</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; sin(vec&lt; L, T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric sine function. </div></div>
<div class="ttc" id="a00102_html"><div class="ttname"><a href="a00102.html">setup.hpp</a></div><div class="ttdoc">GLM Core </div></div>
</div><!-- fragment --></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"/>
</a> 1.8.10
</small></address>
</body>
</html>