a00162.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534
  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.5"/>
  7. <title>GLM: 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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">GLM
  21. &#160;<span id="projectnumber">0.9.5</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.5 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. </div><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#func-members">Functions</a> </div>
  43. <div class="headertitle">
  44. <div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00167.html">GLM Core</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr class="memitem:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gac85497ed2e39d4cac4ac32bed4dfc506">acos</a> (genType const &amp;x)</td></tr>
  52. <tr class="separator:gac85497ed2e39d4cac4ac32bed4dfc506"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  54. <tr class="memitem:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga961d72b4a20d09d6e71fdf076ad4f433">acosh</a> (genType const &amp;x)</td></tr>
  55. <tr class="separator:ga961d72b4a20d09d6e71fdf076ad4f433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:gafca5e8c71ea06be0840227b4aafc5680"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  57. <tr class="memitem:gafca5e8c71ea06be0840227b4aafc5680"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gafca5e8c71ea06be0840227b4aafc5680">asin</a> (genType const &amp;x)</td></tr>
  58. <tr class="separator:gafca5e8c71ea06be0840227b4aafc5680"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  60. <tr class="memitem:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa52acc1218a5ddd0f8d94fcd098685b1">asinh</a> (genType const &amp;x)</td></tr>
  61. <tr class="separator:gaa52acc1218a5ddd0f8d94fcd098685b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  63. <tr class="memitem:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gabf80ac0817d1db032dd6a0969aa2b84a">atan</a> (genType const &amp;y, genType const &amp;x)</td></tr>
  64. <tr class="separator:gabf80ac0817d1db032dd6a0969aa2b84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  66. <tr class="memitem:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa7be96f0c12a40eeac5c7f04a3d465a1">atan</a> (genType const &amp;y_over_x)</td></tr>
  67. <tr class="separator:gaa7be96f0c12a40eeac5c7f04a3d465a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  69. <tr class="memitem:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa20b78cb9c12e30bd5a3054b8cb3d099">atanh</a> (genType const &amp;x)</td></tr>
  70. <tr class="separator:gaa20b78cb9c12e30bd5a3054b8cb3d099"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:gac6708d4f0895dc79b65f50db00840167"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  72. <tr class="memitem:gac6708d4f0895dc79b65f50db00840167"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gac6708d4f0895dc79b65f50db00840167">cos</a> (genType const &amp;angle)</td></tr>
  73. <tr class="separator:gac6708d4f0895dc79b65f50db00840167"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  75. <tr class="memitem:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaa7685634f6e920ba9a683e5ec7aed976">cosh</a> (genType const &amp;angle)</td></tr>
  76. <tr class="separator:gaa7685634f6e920ba9a683e5ec7aed976"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  78. <tr class="memitem:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gaf4e5661bd1c993f6090d49e988a4c78a">degrees</a> (genType const &amp;radians)</td></tr>
  79. <tr class="separator:gaf4e5661bd1c993f6090d49e988a4c78a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga431d31cdb060059bc5b0696e212f1453"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  81. <tr class="memitem:ga431d31cdb060059bc5b0696e212f1453"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga431d31cdb060059bc5b0696e212f1453">radians</a> (genType const &amp;degrees)</td></tr>
  82. <tr class="separator:ga431d31cdb060059bc5b0696e212f1453"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  84. <tr class="memitem:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#gafbab21016b7f3bc21afb09a7e42e2df1">sin</a> (genType const &amp;angle)</td></tr>
  85. <tr class="separator:gafbab21016b7f3bc21afb09a7e42e2df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ga2e8c9a896e803661058de83429aa6eda"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  87. <tr class="memitem:ga2e8c9a896e803661058de83429aa6eda"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga2e8c9a896e803661058de83429aa6eda">sinh</a> (genType const &amp;angle)</td></tr>
  88. <tr class="separator:ga2e8c9a896e803661058de83429aa6eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga328aeb0de4f312dc3d200cb929715d44"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  90. <tr class="memitem:ga328aeb0de4f312dc3d200cb929715d44"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga328aeb0de4f312dc3d200cb929715d44">tan</a> (genType const &amp;angle)</td></tr>
  91. <tr class="separator:ga328aeb0de4f312dc3d200cb929715d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga941f20e5315113d1a2e037f073a62f04"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  93. <tr class="memitem:ga941f20e5315113d1a2e037f073a62f04"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00162.html#ga941f20e5315113d1a2e037f073a62f04">tanh</a> (genType const &amp;angle)</td></tr>
  94. <tr class="separator:ga941f20e5315113d1a2e037f073a62f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
  98. <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>
  99. <p>These all operate component-wise. The description is per component. </p>
  100. <h2 class="groupheader">Function Documentation</h2>
  101. <a class="anchor" id="gac85497ed2e39d4cac4ac32bed4dfc506"></a>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">GLM_FUNC_DECL genType glm::acos </td>
  107. <td>(</td>
  108. <td class="paramtype">genType const &amp;&#160;</td>
  109. <td class="paramname"><em>x</em></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <p>Arc cosine. </p>
  115. <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>
  116. <dl class="tparams"><dt>Template Parameters</dt><dd>
  117. <table class="tparams">
  118. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  119. </table>
  120. </dd>
  121. </dl>
  122. <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>
  123. <dd>
  124. <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>
  125. </div>
  126. </div>
  127. <a class="anchor" id="ga961d72b4a20d09d6e71fdf076ad4f433"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">GLM_FUNC_DECL genType glm::acosh </td>
  133. <td>(</td>
  134. <td class="paramtype">genType const &amp;&#160;</td>
  135. <td class="paramname"><em>x</em></td><td>)</td>
  136. <td></td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p>
  141. <p>Results are undefined if x &lt; 1.</p>
  142. <dl class="tparams"><dt>Template Parameters</dt><dd>
  143. <table class="tparams">
  144. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  145. </table>
  146. </dd>
  147. </dl>
  148. <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>
  149. <dd>
  150. <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>
  151. </div>
  152. </div>
  153. <a class="anchor" id="gafca5e8c71ea06be0840227b4aafc5680"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL genType glm::asin </td>
  159. <td>(</td>
  160. <td class="paramtype">genType const &amp;&#160;</td>
  161. <td class="paramname"><em>x</em></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Arc sine. </p>
  167. <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>
  168. <dl class="tparams"><dt>Template Parameters</dt><dd>
  169. <table class="tparams">
  170. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  171. </table>
  172. </dd>
  173. </dl>
  174. <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>
  175. <dd>
  176. <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>
  177. </div>
  178. </div>
  179. <a class="anchor" id="gaa52acc1218a5ddd0f8d94fcd098685b1"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">GLM_FUNC_DECL genType glm::asinh </td>
  185. <td>(</td>
  186. <td class="paramtype">genType const &amp;&#160;</td>
  187. <td class="paramname"><em>x</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
  193. <dl class="tparams"><dt>Template Parameters</dt><dd>
  194. <table class="tparams">
  195. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. <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>
  200. <dd>
  201. <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>
  202. </div>
  203. </div>
  204. <a class="anchor" id="gabf80ac0817d1db032dd6a0969aa2b84a"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">GLM_FUNC_DECL genType glm::atan </td>
  210. <td>(</td>
  211. <td class="paramtype">genType const &amp;&#160;</td>
  212. <td class="paramname"><em>y</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">genType const &amp;&#160;</td>
  218. <td class="paramname"><em>x</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Arc tangent. </p>
  228. <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>
  229. <dl class="tparams"><dt>Template Parameters</dt><dd>
  230. <table class="tparams">
  231. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</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/atan.xml">GLSL atan 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. <p>Referenced by <a class="el" href="a00017_source.html#l00080">glm::atan2()</a>.</p>
  239. </div>
  240. </div>
  241. <a class="anchor" id="gaa7be96f0c12a40eeac5c7f04a3d465a1"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">GLM_FUNC_DECL genType glm::atan </td>
  247. <td>(</td>
  248. <td class="paramtype">genType const &amp;&#160;</td>
  249. <td class="paramname"><em>y_over_x</em></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Arc tangent. </p>
  255. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
  256. <dl class="tparams"><dt>Template Parameters</dt><dd>
  257. <table class="tparams">
  258. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  259. </table>
  260. </dd>
  261. </dl>
  262. <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>
  263. <dd>
  264. <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>
  265. </div>
  266. </div>
  267. <a class="anchor" id="gaa20b78cb9c12e30bd5a3054b8cb3d099"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">GLM_FUNC_DECL genType glm::atanh </td>
  273. <td>(</td>
  274. <td class="paramtype">genType const &amp;&#160;</td>
  275. <td class="paramname"><em>x</em></td><td>)</td>
  276. <td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
  281. <p>Results are undefined if abs(x) &gt;= 1.</p>
  282. <dl class="tparams"><dt>Template Parameters</dt><dd>
  283. <table class="tparams">
  284. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  285. </table>
  286. </dd>
  287. </dl>
  288. <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>
  289. <dd>
  290. <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>
  291. </div>
  292. </div>
  293. <a class="anchor" id="gac6708d4f0895dc79b65f50db00840167"></a>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">GLM_FUNC_DECL genType glm::cos </td>
  299. <td>(</td>
  300. <td class="paramtype">genType const &amp;&#160;</td>
  301. <td class="paramname"><em>angle</em></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>The standard trigonometric cosine function. </p>
  307. <p>The values returned by this function will range from [-1, 1].</p>
  308. <dl class="tparams"><dt>Template Parameters</dt><dd>
  309. <table class="tparams">
  310. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  311. </table>
  312. </dd>
  313. </dl>
  314. <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>
  315. <dd>
  316. <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>
  317. </div>
  318. </div>
  319. <a class="anchor" id="gaa7685634f6e920ba9a683e5ec7aed976"></a>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">GLM_FUNC_DECL genType glm::cosh </td>
  325. <td>(</td>
  326. <td class="paramtype">genType const &amp;&#160;</td>
  327. <td class="paramname"><em>angle</em></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
  333. <dl class="tparams"><dt>Template Parameters</dt><dd>
  334. <table class="tparams">
  335. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  336. </table>
  337. </dd>
  338. </dl>
  339. <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>
  340. <dd>
  341. <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>
  342. </div>
  343. </div>
  344. <a class="anchor" id="gaf4e5661bd1c993f6090d49e988a4c78a"></a>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">GLM_FUNC_DECL genType glm::degrees </td>
  350. <td>(</td>
  351. <td class="paramtype">genType const &amp;&#160;</td>
  352. <td class="paramname"><em>radians</em></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Converts radians to degrees and returns the result. </p>
  358. <dl class="tparams"><dt>Template Parameters</dt><dd>
  359. <table class="tparams">
  360. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  361. </table>
  362. </dd>
  363. </dl>
  364. <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>
  365. <dd>
  366. <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>
  367. </div>
  368. </div>
  369. <a class="anchor" id="ga431d31cdb060059bc5b0696e212f1453"></a>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname">GLM_FUNC_DECL genType glm::radians </td>
  375. <td>(</td>
  376. <td class="paramtype">genType const &amp;&#160;</td>
  377. <td class="paramname"><em>degrees</em></td><td>)</td>
  378. <td></td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Converts degrees to radians and returns the result. </p>
  383. <dl class="tparams"><dt>Template Parameters</dt><dd>
  384. <table class="tparams">
  385. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  386. </table>
  387. </dd>
  388. </dl>
  389. <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>
  390. <dd>
  391. <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>
  392. </div>
  393. </div>
  394. <a class="anchor" id="gafbab21016b7f3bc21afb09a7e42e2df1"></a>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="memname">
  398. <tr>
  399. <td class="memname">GLM_FUNC_DECL genType glm::sin </td>
  400. <td>(</td>
  401. <td class="paramtype">genType const &amp;&#160;</td>
  402. <td class="paramname"><em>angle</em></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>The standard trigonometric sine function. </p>
  408. <p>The values returned by this function will range from [-1, 1].</p>
  409. <dl class="tparams"><dt>Template Parameters</dt><dd>
  410. <table class="tparams">
  411. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <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>
  416. <dd>
  417. <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>
  418. </div>
  419. </div>
  420. <a class="anchor" id="ga2e8c9a896e803661058de83429aa6eda"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">GLM_FUNC_DECL genType glm::sinh </td>
  426. <td>(</td>
  427. <td class="paramtype">genType const &amp;&#160;</td>
  428. <td class="paramname"><em>angle</em></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
  434. <dl class="tparams"><dt>Template Parameters</dt><dd>
  435. <table class="tparams">
  436. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <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>
  441. <dd>
  442. <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>
  443. </div>
  444. </div>
  445. <a class="anchor" id="ga328aeb0de4f312dc3d200cb929715d44"></a>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname">GLM_FUNC_DECL genType glm::tan </td>
  451. <td>(</td>
  452. <td class="paramtype">genType const &amp;&#160;</td>
  453. <td class="paramname"><em>angle</em></td><td>)</td>
  454. <td></td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>The standard trigonometric tangent function. </p>
  459. <dl class="tparams"><dt>Template Parameters</dt><dd>
  460. <table class="tparams">
  461. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</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/tan.xml">GLSL tan 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="ga941f20e5315113d1a2e037f073a62f04"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">GLM_FUNC_DECL genType glm::tanh </td>
  476. <td>(</td>
  477. <td class="paramtype">genType 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>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
  484. <dl class="tparams"><dt>Template Parameters</dt><dd>
  485. <table class="tparams">
  486. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</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/tanh.xml">GLSL tanh 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. </div><!-- contents -->
  496. <!-- start footer part -->
  497. <hr class="footer"/><address class="footer"><small>
  498. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  499. <img class="footer" src="doxygen.png" alt="doxygen"/>
  500. </a> 1.8.5
  501. </small></address>
  502. </body>
  503. </html>