Platformer in OpenGL
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

636 regels
37 KiB

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