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.

620 lines
33 KiB

преди 5 години
  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="a00698.html">Core features</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gacc9b092df8257c68f19c9053703e2563"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  73. <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="a00790.html#gacc9b092df8257c68f19c9053703e2563">acos</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  74. <tr class="separator:gacc9b092df8257c68f19c9053703e2563"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  76. <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="a00790.html#ga858f35dc66fd2688f20c52b5f25be76a">acosh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  77. <tr class="separator:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  79. <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="a00790.html#ga0552d2df4865fa8c3d7cfc3ec2caac73">asin</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  80. <tr class="separator:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga3ef16b501ee859fddde88e22192a5950"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  82. <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="a00790.html#ga3ef16b501ee859fddde88e22192a5950">asinh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  83. <tr class="separator:ga3ef16b501ee859fddde88e22192a5950"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gac61629f3a4aa14057e7a8cae002291db"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  85. <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="a00790.html#gac61629f3a4aa14057e7a8cae002291db">atan</a> (vec&lt; L, T, Q &gt; const &amp;y, vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  86. <tr class="separator:gac61629f3a4aa14057e7a8cae002291db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ga5229f087eaccbc466f1c609ce3107b95"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  88. <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="a00790.html#ga5229f087eaccbc466f1c609ce3107b95">atan</a> (vec&lt; L, T, Q &gt; const &amp;y_over_x)</td></tr>
  89. <tr class="separator:ga5229f087eaccbc466f1c609ce3107b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:gabc925650e618357d07da255531658b87"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  91. <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="a00790.html#gabc925650e618357d07da255531658b87">atanh</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  92. <tr class="separator:gabc925650e618357d07da255531658b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ga6a41efc740e3b3c937447d3a6284130e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  94. <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="a00790.html#ga6a41efc740e3b3c937447d3a6284130e">cos</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  95. <tr class="separator:ga6a41efc740e3b3c937447d3a6284130e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga4e260e372742c5f517aca196cf1e62b3"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  97. <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="a00790.html#ga4e260e372742c5f517aca196cf1e62b3">cosh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  98. <tr class="separator:ga4e260e372742c5f517aca196cf1e62b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ga8faec9e303538065911ba8b3caf7326b"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  100. <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="a00790.html#ga8faec9e303538065911ba8b3caf7326b">degrees</a> (vec&lt; L, T, Q &gt; const &amp;radians)</td></tr>
  101. <tr class="separator:ga8faec9e303538065911ba8b3caf7326b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  103. <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="a00790.html#ga6e1db4862c5e25afd553930e2fdd6a68">radians</a> (vec&lt; L, T, Q &gt; const &amp;degrees)</td></tr>
  104. <tr class="separator:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ga29747fd108cb7292ae5a284f69691a69"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  106. <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="a00790.html#ga29747fd108cb7292ae5a284f69691a69">sin</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  107. <tr class="separator:ga29747fd108cb7292ae5a284f69691a69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  109. <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="a00790.html#gac7c39ff21809e281552b4dbe46f4a39d">sinh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  110. <tr class="separator:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  112. <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="a00790.html#ga293a34cfb9f0115cc606b4a97c84f11f">tan</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  113. <tr class="separator:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  115. <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="a00790.html#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">tanh</a> (vec&lt; L, T, Q &gt; const &amp;angle)</td></tr>
  116. <tr class="separator:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
  120. <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>
  121. <p>These all operate component-wise. The description is per component.</p>
  122. <p>Include &lt;<a class="el" href="a00647.html" title="Core features ">glm/trigonometric.hpp</a>&gt; to use these core features.</p>
  123. <dl class="section see"><dt>See also</dt><dd>ext_vector_trigonometric </dd></dl>
  124. <h2 class="groupheader">Function Documentation</h2>
  125. <a id="gacc9b092df8257c68f19c9053703e2563"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#gacc9b092df8257c68f19c9053703e2563">&#9670;&nbsp;</a></span>acos()</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::acos </td>
  132. <td>(</td>
  133. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  134. <td class="paramname"><em>x</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. <p>Arc cosine. </p>
  140. <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>
  141. <dl class="tparams"><dt>Template Parameters</dt><dd>
  142. <table class="tparams">
  143. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  144. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  145. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  146. </table>
  147. </dd>
  148. </dl>
  149. <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>
  150. <dd>
  151. <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>
  152. </div>
  153. </div>
  154. <a id="ga858f35dc66fd2688f20c52b5f25be76a"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#ga858f35dc66fd2688f20c52b5f25be76a">&#9670;&nbsp;</a></span>acosh()</h2>
  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::acosh </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 hyperbolic cosine; returns the non-negative inverse of cosh. </p>
  169. <p>Results are undefined if x &lt; 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/acosh.xml">GLSL acosh 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 id="ga0552d2df4865fa8c3d7cfc3ec2caac73"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#ga0552d2df4865fa8c3d7cfc3ec2caac73">&#9670;&nbsp;</a></span>asin()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::asin </td>
  190. <td>(</td>
  191. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  192. <td class="paramname"><em>x</em></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Arc sine. </p>
  198. <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>
  199. <dl class="tparams"><dt>Template Parameters</dt><dd>
  200. <table class="tparams">
  201. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  202. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  203. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. <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>
  208. <dd>
  209. <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>
  210. </div>
  211. </div>
  212. <a id="ga3ef16b501ee859fddde88e22192a5950"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#ga3ef16b501ee859fddde88e22192a5950">&#9670;&nbsp;</a></span>asinh()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::asinh </td>
  219. <td>(</td>
  220. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  221. <td class="paramname"><em>x</em></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
  227. <dl class="tparams"><dt>Template Parameters</dt><dd>
  228. <table class="tparams">
  229. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  230. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  231. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  232. </table>
  233. </dd>
  234. </dl>
  235. <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>
  236. <dd>
  237. <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>
  238. </div>
  239. </div>
  240. <a id="gac61629f3a4aa14057e7a8cae002291db"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#gac61629f3a4aa14057e7a8cae002291db">&#9670;&nbsp;</a></span>atan() <span class="overload">[1/2]</span></h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atan </td>
  247. <td>(</td>
  248. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  249. <td class="paramname"><em>y</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  255. <td class="paramname"><em>x</em>&#160;</td>
  256. </tr>
  257. <tr>
  258. <td></td>
  259. <td>)</td>
  260. <td></td><td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Arc tangent. </p>
  265. <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>
  266. <dl class="tparams"><dt>Template Parameters</dt><dd>
  267. <table class="tparams">
  268. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  269. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  270. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  271. </table>
  272. </dd>
  273. </dl>
  274. <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>
  275. <dd>
  276. <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>
  277. <p class="reference">Referenced by <a class="el" href="a00461_source.html#l00055">glm::atan2()</a>.</p>
  278. </div>
  279. </div>
  280. <a id="ga5229f087eaccbc466f1c609ce3107b95"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#ga5229f087eaccbc466f1c609ce3107b95">&#9670;&nbsp;</a></span>atan() <span class="overload">[2/2]</span></h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atan </td>
  287. <td>(</td>
  288. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  289. <td class="paramname"><em>y_over_x</em></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Arc tangent. </p>
  295. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
  296. <dl class="tparams"><dt>Template Parameters</dt><dd>
  297. <table class="tparams">
  298. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  299. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  300. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  301. </table>
  302. </dd>
  303. </dl>
  304. <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>
  305. <dd>
  306. <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>
  307. </div>
  308. </div>
  309. <a id="gabc925650e618357d07da255531658b87"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#gabc925650e618357d07da255531658b87">&#9670;&nbsp;</a></span>atanh()</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::atanh </td>
  316. <td>(</td>
  317. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  318. <td class="paramname"><em>x</em></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
  324. <p>Results are undefined if abs(x) &gt;= 1.</p>
  325. <dl class="tparams"><dt>Template Parameters</dt><dd>
  326. <table class="tparams">
  327. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  328. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  329. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  330. </table>
  331. </dd>
  332. </dl>
  333. <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>
  334. <dd>
  335. <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>
  336. </div>
  337. </div>
  338. <a id="ga6a41efc740e3b3c937447d3a6284130e"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#ga6a41efc740e3b3c937447d3a6284130e">&#9670;&nbsp;</a></span>cos()</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::cos </td>
  345. <td>(</td>
  346. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  347. <td class="paramname"><em>angle</em></td><td>)</td>
  348. <td></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>The standard trigonometric cosine function. </p>
  353. <p>The values returned by this function will range from [-1, 1].</p>
  354. <dl class="tparams"><dt>Template Parameters</dt><dd>
  355. <table class="tparams">
  356. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  357. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  358. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  359. </table>
  360. </dd>
  361. </dl>
  362. <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>
  363. <dd>
  364. <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>
  365. </div>
  366. </div>
  367. <a id="ga4e260e372742c5f517aca196cf1e62b3"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#ga4e260e372742c5f517aca196cf1e62b3">&#9670;&nbsp;</a></span>cosh()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::cosh </td>
  374. <td>(</td>
  375. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  376. <td class="paramname"><em>angle</em></td><td>)</td>
  377. <td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
  382. <dl class="tparams"><dt>Template Parameters</dt><dd>
  383. <table class="tparams">
  384. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  385. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  386. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  387. </table>
  388. </dd>
  389. </dl>
  390. <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>
  391. <dd>
  392. <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>
  393. </div>
  394. </div>
  395. <a id="ga8faec9e303538065911ba8b3caf7326b"></a>
  396. <h2 class="memtitle"><span class="permalink"><a href="#ga8faec9e303538065911ba8b3caf7326b">&#9670;&nbsp;</a></span>degrees()</h2>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, Q&gt; glm::degrees </td>
  402. <td>(</td>
  403. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  404. <td class="paramname"><em>radians</em></td><td>)</td>
  405. <td></td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Converts radians to degrees and returns the result. </p>
  410. <dl class="tparams"><dt>Template Parameters</dt><dd>
  411. <table class="tparams">
  412. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  413. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  414. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  415. </table>
  416. </dd>
  417. </dl>
  418. <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>
  419. <dd>
  420. <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>
  421. </div>
  422. </div>
  423. <a id="ga6e1db4862c5e25afd553930e2fdd6a68"></a>
  424. <h2 class="memtitle"><span class="permalink"><a href="#ga6e1db4862c5e25afd553930e2fdd6a68">&#9670;&nbsp;</a></span>radians()</h2>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;L, T, Q&gt; glm::radians </td>
  430. <td>(</td>
  431. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  432. <td class="paramname"><em>degrees</em></td><td>)</td>
  433. <td></td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. <p>Converts degrees to radians and returns the result. </p>
  438. <dl class="tparams"><dt>Template Parameters</dt><dd>
  439. <table class="tparams">
  440. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  441. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  442. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  443. </table>
  444. </dd>
  445. </dl>
  446. <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>
  447. <dd>
  448. <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>
  449. </div>
  450. </div>
  451. <a id="ga29747fd108cb7292ae5a284f69691a69"></a>
  452. <h2 class="memtitle"><span class="permalink"><a href="#ga29747fd108cb7292ae5a284f69691a69">&#9670;&nbsp;</a></span>sin()</h2>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::sin </td>
  458. <td>(</td>
  459. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  460. <td class="paramname"><em>angle</em></td><td>)</td>
  461. <td></td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. <p>The standard trigonometric sine function. </p>
  466. <p>The values returned by this function will range from [-1, 1].</p>
  467. <dl class="tparams"><dt>Template Parameters</dt><dd>
  468. <table class="tparams">
  469. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  470. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  471. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  472. </table>
  473. </dd>
  474. </dl>
  475. <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>
  476. <dd>
  477. <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>
  478. </div>
  479. </div>
  480. <a id="gac7c39ff21809e281552b4dbe46f4a39d"></a>
  481. <h2 class="memtitle"><span class="permalink"><a href="#gac7c39ff21809e281552b4dbe46f4a39d">&#9670;&nbsp;</a></span>sinh()</h2>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::sinh </td>
  487. <td>(</td>
  488. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  489. <td class="paramname"><em>angle</em></td><td>)</td>
  490. <td></td>
  491. </tr>
  492. </table>
  493. </div><div class="memdoc">
  494. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
  495. <dl class="tparams"><dt>Template Parameters</dt><dd>
  496. <table class="tparams">
  497. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  498. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  499. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  500. </table>
  501. </dd>
  502. </dl>
  503. <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>
  504. <dd>
  505. <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>
  506. </div>
  507. </div>
  508. <a id="ga293a34cfb9f0115cc606b4a97c84f11f"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#ga293a34cfb9f0115cc606b4a97c84f11f">&#9670;&nbsp;</a></span>tan()</h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <table class="memname">
  513. <tr>
  514. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::tan </td>
  515. <td>(</td>
  516. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  517. <td class="paramname"><em>angle</em></td><td>)</td>
  518. <td></td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p>The standard trigonometric tangent function. </p>
  523. <dl class="tparams"><dt>Template Parameters</dt><dd>
  524. <table class="tparams">
  525. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  526. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  527. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  528. </table>
  529. </dd>
  530. </dl>
  531. <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>
  532. <dd>
  533. <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>
  534. </div>
  535. </div>
  536. <a id="gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"></a>
  537. <h2 class="memtitle"><span class="permalink"><a href="#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">&#9670;&nbsp;</a></span>tanh()</h2>
  538. <div class="memitem">
  539. <div class="memproto">
  540. <table class="memname">
  541. <tr>
  542. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::tanh </td>
  543. <td>(</td>
  544. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  545. <td class="paramname"><em>angle</em></td><td>)</td>
  546. <td></td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
  551. <dl class="tparams"><dt>Template Parameters</dt><dd>
  552. <table class="tparams">
  553. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  554. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  555. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  556. </table>
  557. </dd>
  558. </dl>
  559. <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>
  560. <dd>
  561. <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>
  562. </div>
  563. </div>
  564. </div><!-- contents -->
  565. <!-- start footer part -->
  566. <hr class="footer"/><address class="footer"><small>
  567. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  568. <img class="footer" src="doxygen.png" alt="doxygen"/>
  569. </a> 1.8.14
  570. </small></address>
  571. </body>
  572. </html>