a00373.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.9 API documentation: Angle and Trigonometry Functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documentation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00280.html">Core features</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Function parameters specified as angle are assumed to be in units of radians.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <tr class="memitem:gacc9b092df8257c68f19c9053703e2563"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:gacc9b092df8257c68f19c9053703e2563"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#gacc9b092df8257c68f19c9053703e2563">acos</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  89. <tr class="memdesc:gacc9b092df8257c68f19c9053703e2563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc cosine. <a href="a00373.html#gacc9b092df8257c68f19c9053703e2563">More...</a><br /></td></tr>
  90. <tr class="separator:gacc9b092df8257c68f19c9053703e2563"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  92. <tr class="memitem:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga858f35dc66fd2688f20c52b5f25be76a">acosh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  93. <tr class="memdesc:ga858f35dc66fd2688f20c52b5f25be76a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic cosine; returns the non-negative inverse of cosh. <a href="a00373.html#ga858f35dc66fd2688f20c52b5f25be76a">More...</a><br /></td></tr>
  94. <tr class="separator:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  96. <tr class="memitem:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga0552d2df4865fa8c3d7cfc3ec2caac73">asin</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  97. <tr class="memdesc:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc sine. <a href="a00373.html#ga0552d2df4865fa8c3d7cfc3ec2caac73">More...</a><br /></td></tr>
  98. <tr class="separator:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ga3ef16b501ee859fddde88e22192a5950"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  100. <tr class="memitem:ga3ef16b501ee859fddde88e22192a5950"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga3ef16b501ee859fddde88e22192a5950">asinh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  101. <tr class="memdesc:ga3ef16b501ee859fddde88e22192a5950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic sine; returns the inverse of sinh. <a href="a00373.html#ga3ef16b501ee859fddde88e22192a5950">More...</a><br /></td></tr>
  102. <tr class="separator:ga3ef16b501ee859fddde88e22192a5950"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:gac61629f3a4aa14057e7a8cae002291db"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  104. <tr class="memitem:gac61629f3a4aa14057e7a8cae002291db"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#gac61629f3a4aa14057e7a8cae002291db">atan</a> (vec&lt; L, T, Q &gt; const &amp;y, vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  105. <tr class="memdesc:gac61629f3a4aa14057e7a8cae002291db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent. <a href="a00373.html#gac61629f3a4aa14057e7a8cae002291db">More...</a><br /></td></tr>
  106. <tr class="separator:gac61629f3a4aa14057e7a8cae002291db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ga5229f087eaccbc466f1c609ce3107b95"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  108. <tr class="memitem:ga5229f087eaccbc466f1c609ce3107b95"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga5229f087eaccbc466f1c609ce3107b95">atan</a> (vec&lt; L, T, Q &gt; const &amp;y_over_x)</td></tr>
  109. <tr class="memdesc:ga5229f087eaccbc466f1c609ce3107b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent. <a href="a00373.html#ga5229f087eaccbc466f1c609ce3107b95">More...</a><br /></td></tr>
  110. <tr class="separator:ga5229f087eaccbc466f1c609ce3107b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:gabc925650e618357d07da255531658b87"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  112. <tr class="memitem:gabc925650e618357d07da255531658b87"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#gabc925650e618357d07da255531658b87">atanh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  113. <tr class="memdesc:gabc925650e618357d07da255531658b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic tangent; returns the inverse of tanh. <a href="a00373.html#gabc925650e618357d07da255531658b87">More...</a><br /></td></tr>
  114. <tr class="separator:gabc925650e618357d07da255531658b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ga6a41efc740e3b3c937447d3a6284130e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  116. <tr class="memitem:ga6a41efc740e3b3c937447d3a6284130e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga6a41efc740e3b3c937447d3a6284130e">cos</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  117. <tr class="memdesc:ga6a41efc740e3b3c937447d3a6284130e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric cosine function. <a href="a00373.html#ga6a41efc740e3b3c937447d3a6284130e">More...</a><br /></td></tr>
  118. <tr class="separator:ga6a41efc740e3b3c937447d3a6284130e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ga4e260e372742c5f517aca196cf1e62b3"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  120. <tr class="memitem:ga4e260e372742c5f517aca196cf1e62b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga4e260e372742c5f517aca196cf1e62b3">cosh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  121. <tr class="memdesc:ga4e260e372742c5f517aca196cf1e62b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. <a href="a00373.html#ga4e260e372742c5f517aca196cf1e62b3">More...</a><br /></td></tr>
  122. <tr class="separator:ga4e260e372742c5f517aca196cf1e62b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga8faec9e303538065911ba8b3caf7326b"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  124. <tr class="memitem:ga8faec9e303538065911ba8b3caf7326b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga8faec9e303538065911ba8b3caf7326b">degrees</a> (vec&lt; L, T, Q &gt; const &amp;radians)</td></tr>
  125. <tr class="memdesc:ga8faec9e303538065911ba8b3caf7326b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts radians to degrees and returns the result. <a href="a00373.html#ga8faec9e303538065911ba8b3caf7326b">More...</a><br /></td></tr>
  126. <tr class="separator:ga8faec9e303538065911ba8b3caf7326b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  128. <tr class="memitem:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga6e1db4862c5e25afd553930e2fdd6a68">radians</a> (vec&lt; L, T, Q &gt; const &amp;degrees)</td></tr>
  129. <tr class="memdesc:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts degrees to radians and returns the result. <a href="a00373.html#ga6e1db4862c5e25afd553930e2fdd6a68">More...</a><br /></td></tr>
  130. <tr class="separator:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga29747fd108cb7292ae5a284f69691a69"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  132. <tr class="memitem:ga29747fd108cb7292ae5a284f69691a69"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga29747fd108cb7292ae5a284f69691a69">sin</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  133. <tr class="memdesc:ga29747fd108cb7292ae5a284f69691a69"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric sine function. <a href="a00373.html#ga29747fd108cb7292ae5a284f69691a69">More...</a><br /></td></tr>
  134. <tr class="separator:ga29747fd108cb7292ae5a284f69691a69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  136. <tr class="memitem:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#gac7c39ff21809e281552b4dbe46f4a39d">sinh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  137. <tr class="memdesc:gac7c39ff21809e281552b4dbe46f4a39d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. <a href="a00373.html#gac7c39ff21809e281552b4dbe46f4a39d">More...</a><br /></td></tr>
  138. <tr class="separator:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  140. <tr class="memitem:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#ga293a34cfb9f0115cc606b4a97c84f11f">tan</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  141. <tr class="memdesc:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric tangent function. <a href="a00373.html#ga293a34cfb9f0115cc606b4a97c84f11f">More...</a><br /></td></tr>
  142. <tr class="separator:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  144. <tr class="memitem:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00373.html#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">tanh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  145. <tr class="memdesc:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) <a href="a00373.html#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">More...</a><br /></td></tr>
  146. <tr class="separator:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  149. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
  150. <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>
  151. <p>These all operate component-wise. The description is per component.</p>
  152. <p>Include &lt;<a class="el" href="a00160.html" title="Core features ">glm/trigonometric.hpp</a>&gt; to use these core features.</p>
  153. <dl class="section see"><dt>See also</dt><dd>ext_vector_trigonometric </dd></dl>
  154. <h2 class="groupheader">Function Documentation</h2>
  155. <a class="anchor" id="gacc9b092df8257c68f19c9053703e2563"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::acos </td>
  161. <td>(</td>
  162. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  163. <td class="paramname"><em>x</em></td><td>)</td>
  164. <td></td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Arc cosine. </p>
  169. <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>
  170. <dl class="tparams"><dt>Template Parameters</dt><dd>
  171. <table class="tparams">
  172. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  173. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  174. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  175. </table>
  176. </dd>
  177. </dl>
  178. <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>
  179. <dd>
  180. <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>
  181. </div>
  182. </div>
  183. <a class="anchor" id="ga858f35dc66fd2688f20c52b5f25be76a"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::acosh </td>
  189. <td>(</td>
  190. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  191. <td class="paramname"><em>x</em></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p>
  197. <p>Results are undefined if x &lt; 1.</p>
  198. <dl class="tparams"><dt>Template Parameters</dt><dd>
  199. <table class="tparams">
  200. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  201. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  202. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  203. </table>
  204. </dd>
  205. </dl>
  206. <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>
  207. <dd>
  208. <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>
  209. </div>
  210. </div>
  211. <a class="anchor" id="ga0552d2df4865fa8c3d7cfc3ec2caac73"></a>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::asin </td>
  217. <td>(</td>
  218. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  219. <td class="paramname"><em>x</em></td><td>)</td>
  220. <td></td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Arc sine. </p>
  225. <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>
  226. <dl class="tparams"><dt>Template Parameters</dt><dd>
  227. <table class="tparams">
  228. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  229. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  230. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <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>
  235. <dd>
  236. <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>
  237. </div>
  238. </div>
  239. <a class="anchor" id="ga3ef16b501ee859fddde88e22192a5950"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::asinh </td>
  245. <td>(</td>
  246. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  247. <td class="paramname"><em>x</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
  253. <dl class="tparams"><dt>Template Parameters</dt><dd>
  254. <table class="tparams">
  255. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  256. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  257. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  258. </table>
  259. </dd>
  260. </dl>
  261. <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>
  262. <dd>
  263. <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>
  264. </div>
  265. </div>
  266. <a class="anchor" id="gac61629f3a4aa14057e7a8cae002291db"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atan </td>
  272. <td>(</td>
  273. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  274. <td class="paramname"><em>y</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  280. <td class="paramname"><em>x</em>&#160;</td>
  281. </tr>
  282. <tr>
  283. <td></td>
  284. <td>)</td>
  285. <td></td><td></td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Arc tangent. </p>
  290. <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>
  291. <dl class="tparams"><dt>Template Parameters</dt><dd>
  292. <table class="tparams">
  293. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  294. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  295. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  296. </table>
  297. </dd>
  298. </dl>
  299. <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>
  300. <dd>
  301. <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>
  302. <p>Referenced by <a class="el" href="a00017_source.html#l00055">glm::atan2()</a>.</p>
  303. </div>
  304. </div>
  305. <a class="anchor" id="ga5229f087eaccbc466f1c609ce3107b95"></a>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atan </td>
  311. <td>(</td>
  312. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  313. <td class="paramname"><em>y_over_x</em></td><td>)</td>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. <p>Arc tangent. </p>
  319. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
  320. <dl class="tparams"><dt>Template Parameters</dt><dd>
  321. <table class="tparams">
  322. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  323. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  324. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  325. </table>
  326. </dd>
  327. </dl>
  328. <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>
  329. <dd>
  330. <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>
  331. </div>
  332. </div>
  333. <a class="anchor" id="gabc925650e618357d07da255531658b87"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atanh </td>
  339. <td>(</td>
  340. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  341. <td class="paramname"><em>x</em></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
  347. <p>Results are undefined if abs(x) &gt;= 1.</p>
  348. <dl class="tparams"><dt>Template Parameters</dt><dd>
  349. <table class="tparams">
  350. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  351. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  352. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  353. </table>
  354. </dd>
  355. </dl>
  356. <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>
  357. <dd>
  358. <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>
  359. </div>
  360. </div>
  361. <a class="anchor" id="ga6a41efc740e3b3c937447d3a6284130e"></a>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="memname">
  365. <tr>
  366. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::cos </td>
  367. <td>(</td>
  368. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  369. <td class="paramname"><em>angle</em></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <p>The standard trigonometric cosine function. </p>
  375. <p>The values returned by this function will range from [-1, 1].</p>
  376. <dl class="tparams"><dt>Template Parameters</dt><dd>
  377. <table class="tparams">
  378. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  379. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  380. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  381. </table>
  382. </dd>
  383. </dl>
  384. <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>
  385. <dd>
  386. <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>
  387. </div>
  388. </div>
  389. <a class="anchor" id="ga4e260e372742c5f517aca196cf1e62b3"></a>
  390. <div class="memitem">
  391. <div class="memproto">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::cosh </td>
  395. <td>(</td>
  396. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  397. <td class="paramname"><em>angle</em></td><td>)</td>
  398. <td></td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
  403. <dl class="tparams"><dt>Template Parameters</dt><dd>
  404. <table class="tparams">
  405. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  406. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  407. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  408. </table>
  409. </dd>
  410. </dl>
  411. <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>
  412. <dd>
  413. <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>
  414. </div>
  415. </div>
  416. <a class="anchor" id="ga8faec9e303538065911ba8b3caf7326b"></a>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, Q&gt; glm::degrees </td>
  422. <td>(</td>
  423. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  424. <td class="paramname"><em>radians</em></td><td>)</td>
  425. <td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Converts radians to degrees and returns the result. </p>
  430. <dl class="tparams"><dt>Template Parameters</dt><dd>
  431. <table class="tparams">
  432. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  433. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  434. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  435. </table>
  436. </dd>
  437. </dl>
  438. <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>
  439. <dd>
  440. <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>
  441. </div>
  442. </div>
  443. <a class="anchor" id="ga6e1db4862c5e25afd553930e2fdd6a68"></a>
  444. <div class="memitem">
  445. <div class="memproto">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, Q&gt; glm::radians </td>
  449. <td>(</td>
  450. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  451. <td class="paramname"><em>degrees</em></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>Converts degrees to radians and returns the result. </p>
  457. <dl class="tparams"><dt>Template Parameters</dt><dd>
  458. <table class="tparams">
  459. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  460. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  461. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  462. </table>
  463. </dd>
  464. </dl>
  465. <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>
  466. <dd>
  467. <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>
  468. </div>
  469. </div>
  470. <a class="anchor" id="ga29747fd108cb7292ae5a284f69691a69"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::sin </td>
  476. <td>(</td>
  477. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  478. <td class="paramname"><em>angle</em></td><td>)</td>
  479. <td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>The standard trigonometric sine function. </p>
  484. <p>The values returned by this function will range from [-1, 1].</p>
  485. <dl class="tparams"><dt>Template Parameters</dt><dd>
  486. <table class="tparams">
  487. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  488. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  489. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  490. </table>
  491. </dd>
  492. </dl>
  493. <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>
  494. <dd>
  495. <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>
  496. </div>
  497. </div>
  498. <a class="anchor" id="gac7c39ff21809e281552b4dbe46f4a39d"></a>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::sinh </td>
  504. <td>(</td>
  505. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  506. <td class="paramname"><em>angle</em></td><td>)</td>
  507. <td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
  512. <dl class="tparams"><dt>Template Parameters</dt><dd>
  513. <table class="tparams">
  514. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  515. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  516. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  517. </table>
  518. </dd>
  519. </dl>
  520. <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>
  521. <dd>
  522. <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>
  523. </div>
  524. </div>
  525. <a class="anchor" id="ga293a34cfb9f0115cc606b4a97c84f11f"></a>
  526. <div class="memitem">
  527. <div class="memproto">
  528. <table class="memname">
  529. <tr>
  530. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::tan </td>
  531. <td>(</td>
  532. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  533. <td class="paramname"><em>angle</em></td><td>)</td>
  534. <td></td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. <p>The standard trigonometric tangent function. </p>
  539. <dl class="tparams"><dt>Template Parameters</dt><dd>
  540. <table class="tparams">
  541. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  542. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  543. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  544. </table>
  545. </dd>
  546. </dl>
  547. <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>
  548. <dd>
  549. <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>
  550. </div>
  551. </div>
  552. <a class="anchor" id="gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"></a>
  553. <div class="memitem">
  554. <div class="memproto">
  555. <table class="memname">
  556. <tr>
  557. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::tanh </td>
  558. <td>(</td>
  559. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  560. <td class="paramname"><em>angle</em></td><td>)</td>
  561. <td></td>
  562. </tr>
  563. </table>
  564. </div><div class="memdoc">
  565. <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
  566. <dl class="tparams"><dt>Template Parameters</dt><dd>
  567. <table class="tparams">
  568. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  569. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  570. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  571. </table>
  572. </dd>
  573. </dl>
  574. <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>
  575. <dd>
  576. <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>
  577. </div>
  578. </div>
  579. </div><!-- contents -->
  580. <!-- start footer part -->
  581. <hr class="footer"/><address class="footer"><small>
  582. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  583. <img class="footer" src="doxygen.png" alt="doxygen"/>
  584. </a> 1.8.10
  585. </small></address>
  586. </body>
  587. </html>