a00158.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.7: 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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.7
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  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="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00162.html">GLM Core</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  49. <tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga58ad259b788528fe0a4bd2eeb5e381cc">acos</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  50. <tr class="separator:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  52. <tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga3f368ad3e1883b60748ca2634d816104">acosh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  53. <tr class="separator:ga3f368ad3e1883b60748ca2634d816104"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  55. <tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga88e29b8289e882859d76a25798dd9490">asin</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  56. <tr class="separator:ga88e29b8289e882859d76a25798dd9490"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  58. <tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga72bf44c1984e1afb63acf821ba33cac7">asinh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  59. <tr class="separator:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  61. <tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga461e769acb8b8cb695a5a89334546611">atan</a> (vecType&lt; T, P &gt; const &amp;y, vecType&lt; T, P &gt; const &amp;x)</td></tr>
  62. <tr class="separator:ga461e769acb8b8cb695a5a89334546611"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  64. <tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a> (vecType&lt; T, P &gt; const &amp;y_over_x)</td></tr>
  65. <tr class="separator:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  67. <tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#gaffa8decdd8620759f4e6fe4834768b87">atanh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  68. <tr class="separator:gaffa8decdd8620759f4e6fe4834768b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  70. <tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga728fd86f14609e37d83f82429995b7b3">cos</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  71. <tr class="separator:ga728fd86f14609e37d83f82429995b7b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  73. <tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga660582a4e5e843b6c1cd535777e8c295">cosh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  74. <tr class="separator:ga660582a4e5e843b6c1cd535777e8c295"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga402144a18234e642b702bf585599b46d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  76. <tr class="memitem:ga402144a18234e642b702bf585599b46d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga402144a18234e642b702bf585599b46d">degrees</a> (vecType&lt; T, P &gt; const &amp;radians)</td></tr>
  77. <tr class="separator:ga402144a18234e642b702bf585599b46d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  79. <tr class="memitem:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga0fd3ad793538521f76fa30db7f6edfed">radians</a> (vecType&lt; T, P &gt; const &amp;degrees)</td></tr>
  80. <tr class="separator:ga0fd3ad793538521f76fa30db7f6edfed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  82. <tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">sin</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  83. <tr class="separator:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  85. <tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#gad8f89c12efe6f8d3ae8046625b266254">sinh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  86. <tr class="separator:gad8f89c12efe6f8d3ae8046625b266254"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  88. <tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#gab3ae890c38b7d3aa4d5e00998fd296b2">tan</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  89. <tr class="separator:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  91. <tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00158.html#ga234e904a0075f88654a594b5f837711f">tanh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  92. <tr class="separator:ga234e904a0075f88654a594b5f837711f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
  96. <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>
  97. <p>These all operate component-wise. The description is per component. </p>
  98. <h2 class="groupheader">Function Documentation</h2>
  99. <a class="anchor" id="ga58ad259b788528fe0a4bd2eeb5e381cc"></a>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acos </td>
  105. <td>(</td>
  106. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  107. <td class="paramname"><em>x</em></td><td>)</td>
  108. <td></td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <p>Arc cosine. </p>
  113. <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>
  114. <dl class="tparams"><dt>Template Parameters</dt><dd>
  115. <table class="tparams">
  116. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  117. </table>
  118. </dd>
  119. </dl>
  120. <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>
  121. <dd>
  122. <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>
  123. </div>
  124. </div>
  125. <a class="anchor" id="ga3f368ad3e1883b60748ca2634d816104"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acosh </td>
  131. <td>(</td>
  132. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  133. <td class="paramname"><em>x</em></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p>
  139. <p>Results are undefined if x &lt; 1.</p>
  140. <dl class="tparams"><dt>Template Parameters</dt><dd>
  141. <table class="tparams">
  142. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  143. </table>
  144. </dd>
  145. </dl>
  146. <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>
  147. <dd>
  148. <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>
  149. </div>
  150. </div>
  151. <a class="anchor" id="ga88e29b8289e882859d76a25798dd9490"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asin </td>
  157. <td>(</td>
  158. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  159. <td class="paramname"><em>x</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Arc sine. </p>
  165. <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>
  166. <dl class="tparams"><dt>Template Parameters</dt><dd>
  167. <table class="tparams">
  168. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  169. </table>
  170. </dd>
  171. </dl>
  172. <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>
  173. <dd>
  174. <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>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ga72bf44c1984e1afb63acf821ba33cac7"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asinh </td>
  183. <td>(</td>
  184. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  185. <td class="paramname"><em>x</em></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
  191. <dl class="tparams"><dt>Template Parameters</dt><dd>
  192. <table class="tparams">
  193. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  194. </table>
  195. </dd>
  196. </dl>
  197. <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>
  198. <dd>
  199. <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>
  200. </div>
  201. </div>
  202. <a class="anchor" id="ga461e769acb8b8cb695a5a89334546611"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
  208. <td>(</td>
  209. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  210. <td class="paramname"><em>y</em>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  216. <td class="paramname"><em>x</em>&#160;</td>
  217. </tr>
  218. <tr>
  219. <td></td>
  220. <td>)</td>
  221. <td></td><td></td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Arc tangent. </p>
  226. <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>
  227. <dl class="tparams"><dt>Template Parameters</dt><dd>
  228. <table class="tparams">
  229. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  230. </table>
  231. </dd>
  232. </dl>
  233. <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>
  234. <dd>
  235. <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>
  236. <p>Referenced by <a class="el" href="a00016_source.html#l00081">glm::atan2()</a>.</p>
  237. </div>
  238. </div>
  239. <a class="anchor" id="gae8f22458bba8f2321ceb1bfc4a543216"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
  245. <td>(</td>
  246. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  247. <td class="paramname"><em>y_over_x</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Arc tangent. </p>
  253. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
  254. <dl class="tparams"><dt>Template Parameters</dt><dd>
  255. <table class="tparams">
  256. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <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>
  261. <dd>
  262. <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>
  263. </div>
  264. </div>
  265. <a class="anchor" id="gaffa8decdd8620759f4e6fe4834768b87"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atanh </td>
  271. <td>(</td>
  272. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  273. <td class="paramname"><em>x</em></td><td>)</td>
  274. <td></td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
  279. <p>Results are undefined if abs(x) &gt;= 1.</p>
  280. <dl class="tparams"><dt>Template Parameters</dt><dd>
  281. <table class="tparams">
  282. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  283. </table>
  284. </dd>
  285. </dl>
  286. <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>
  287. <dd>
  288. <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>
  289. </div>
  290. </div>
  291. <a class="anchor" id="ga728fd86f14609e37d83f82429995b7b3"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cos </td>
  297. <td>(</td>
  298. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  299. <td class="paramname"><em>angle</em></td><td>)</td>
  300. <td></td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>The standard trigonometric cosine function. </p>
  305. <p>The values returned by this function will range from [-1, 1].</p>
  306. <dl class="tparams"><dt>Template Parameters</dt><dd>
  307. <table class="tparams">
  308. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  309. </table>
  310. </dd>
  311. </dl>
  312. <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>
  313. <dd>
  314. <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>
  315. </div>
  316. </div>
  317. <a class="anchor" id="ga660582a4e5e843b6c1cd535777e8c295"></a>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cosh </td>
  323. <td>(</td>
  324. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  325. <td class="paramname"><em>angle</em></td><td>)</td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
  331. <dl class="tparams"><dt>Template Parameters</dt><dd>
  332. <table class="tparams">
  333. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <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>
  338. <dd>
  339. <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>
  340. </div>
  341. </div>
  342. <a class="anchor" id="ga402144a18234e642b702bf585599b46d"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::degrees </td>
  348. <td>(</td>
  349. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  350. <td class="paramname"><em>radians</em></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Converts radians to degrees and returns the result. </p>
  356. <dl class="tparams"><dt>Template Parameters</dt><dd>
  357. <table class="tparams">
  358. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</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/degrees.xml">GLSL degrees 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 class="anchor" id="ga0fd3ad793538521f76fa30db7f6edfed"></a>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::radians </td>
  373. <td>(</td>
  374. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  375. <td class="paramname"><em>degrees</em></td><td>)</td>
  376. <td></td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Converts degrees to radians and returns the result. </p>
  381. <dl class="tparams"><dt>Template Parameters</dt><dd>
  382. <table class="tparams">
  383. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  384. </table>
  385. </dd>
  386. </dl>
  387. <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>
  388. <dd>
  389. <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>
  390. </div>
  391. </div>
  392. <a class="anchor" id="ga4a0ddceb6b1e64ce0e4da209dcb021d5"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sin </td>
  398. <td>(</td>
  399. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  400. <td class="paramname"><em>angle</em></td><td>)</td>
  401. <td></td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>The standard trigonometric sine function. </p>
  406. <p>The values returned by this function will range from [-1, 1].</p>
  407. <dl class="tparams"><dt>Template Parameters</dt><dd>
  408. <table class="tparams">
  409. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  410. </table>
  411. </dd>
  412. </dl>
  413. <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>
  414. <dd>
  415. <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>
  416. </div>
  417. </div>
  418. <a class="anchor" id="gad8f89c12efe6f8d3ae8046625b266254"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sinh </td>
  424. <td>(</td>
  425. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  426. <td class="paramname"><em>angle</em></td><td>)</td>
  427. <td></td>
  428. </tr>
  429. </table>
  430. </div><div class="memdoc">
  431. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
  432. <dl class="tparams"><dt>Template Parameters</dt><dd>
  433. <table class="tparams">
  434. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  435. </table>
  436. </dd>
  437. </dl>
  438. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sinh.xml">GLSL sinh man page</a> </dd>
  439. <dd>
  440. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
  441. </div>
  442. </div>
  443. <a class="anchor" id="gab3ae890c38b7d3aa4d5e00998fd296b2"></a>
  444. <div class="memitem">
  445. <div class="memproto">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tan </td>
  449. <td>(</td>
  450. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  451. <td class="paramname"><em>angle</em></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>The standard trigonometric tangent function. </p>
  457. <dl class="tparams"><dt>Template Parameters</dt><dd>
  458. <table class="tparams">
  459. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  460. </table>
  461. </dd>
  462. </dl>
  463. <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>
  464. <dd>
  465. <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>
  466. </div>
  467. </div>
  468. <a class="anchor" id="ga234e904a0075f88654a594b5f837711f"></a>
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="memname">
  472. <tr>
  473. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tanh </td>
  474. <td>(</td>
  475. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  476. <td class="paramname"><em>angle</em></td><td>)</td>
  477. <td></td>
  478. </tr>
  479. </table>
  480. </div><div class="memdoc">
  481. <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
  482. <dl class="tparams"><dt>Template Parameters</dt><dd>
  483. <table class="tparams">
  484. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  485. </table>
  486. </dd>
  487. </dl>
  488. <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>
  489. <dd>
  490. <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>
  491. </div>
  492. </div>
  493. </div><!-- contents -->
  494. <!-- start footer part -->
  495. <hr class="footer"/><address class="footer"><small>
  496. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  497. <img class="footer" src="doxygen.png" alt="doxygen"/>
  498. </a> 1.8.10
  499. </small></address>
  500. </body>
  501. </html>