Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.4
Branches Tags
glm
/
doc
/
api
/
a00136.html

a00136.html 26 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Angle and Trigonometry Functions</title>
    7. 

  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    19. 

  19.  </tr>
    20. 

  20.  </tbody>
    21. 

  21. </table>
    22. 

  22. </div>
    23. 

  23. <!-- end header part -->
    24. 

  24. <!-- Generated by Doxygen 1.8.2 -->
    25. 

  25.   <div id="navrow1" class="tabs">
    26. 

  26.     <ul class="tablist">
    27. 

  27.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    28. 

  28.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    29. 

  29.       <li><a href="modules.html"><span>Modules</span></a></li>
    30. 

  30.       <li><a href="files.html"><span>Files</span></a></li>
    31. 

  31.     </ul>
    32. 

  32.   </div>
    33. 

  33. </div><!-- top -->
    34. 

  34. <div class="header">
    35. 

  35.   <div class="summary">
    36. 

  36. <a href="#func-members">Functions</a>  </div>
    37. 

  37.   <div class="headertitle">
    38. 

  38. <div class="title">Angle and Trigonometry Functions</div>  </div>
    39. 

  39. <div class="ingroups"><a class="el" href="a00141.html">GLM Core</a></div></div><!--header-->
    40. 

  40. <div class="contents">
    41. 

  41. <table class="memberdecls">
    42. 

  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    43. 

  43. Functions</h2></td></tr>
    44. 

  44. <tr class="memitem:gafef7954b5fa3228f4aaabde8dfa862a1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    45. 

  45. <tr class="memitem:gafef7954b5fa3228f4aaabde8dfa862a1"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#gafef7954b5fa3228f4aaabde8dfa862a1">acos</a> (genType const &amp;x)</td></tr>
    46. 

  46. <tr class="separator:gafef7954b5fa3228f4aaabde8dfa862a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    47. 

  47. <tr class="memitem:ga0f37ff6b6878a0169cd41249e5377e09"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    48. 

  48. <tr class="memitem:ga0f37ff6b6878a0169cd41249e5377e09"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga0f37ff6b6878a0169cd41249e5377e09">acosh</a> (genType const &amp;x)</td></tr>
    49. 

  49. <tr class="separator:ga0f37ff6b6878a0169cd41249e5377e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
    50. 

  50. <tr class="memitem:ga76b6422e62c99fa0849abdf21fcef5cf"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    51. 

  51. <tr class="memitem:ga76b6422e62c99fa0849abdf21fcef5cf"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga76b6422e62c99fa0849abdf21fcef5cf">asin</a> (genType const &amp;x)</td></tr>
    52. 

  52. <tr class="separator:ga76b6422e62c99fa0849abdf21fcef5cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem:ga615d386dcfb41cdbbca2609c53113aac"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    54. 

  54. <tr class="memitem:ga615d386dcfb41cdbbca2609c53113aac"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga615d386dcfb41cdbbca2609c53113aac">asinh</a> (genType const &amp;x)</td></tr>
    55. 

  55. <tr class="separator:ga615d386dcfb41cdbbca2609c53113aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:ga2394d11075a74869cd88473c76722bc8"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    57. 

  57. <tr class="memitem:ga2394d11075a74869cd88473c76722bc8"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga2394d11075a74869cd88473c76722bc8">atan</a> (genType const &amp;y, genType const &amp;x)</td></tr>
    58. 

  58. <tr class="separator:ga2394d11075a74869cd88473c76722bc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:ga5db83034488156692939acb4f4e46fa6"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    60. 

  60. <tr class="memitem:ga5db83034488156692939acb4f4e46fa6"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga5db83034488156692939acb4f4e46fa6">atan</a> (genType const &amp;y_over_x)</td></tr>
    61. 

  61. <tr class="separator:ga5db83034488156692939acb4f4e46fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:gadeda850d5dff43d4d069854b1b6a623c"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    63. 

  63. <tr class="memitem:gadeda850d5dff43d4d069854b1b6a623c"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#gadeda850d5dff43d4d069854b1b6a623c">atanh</a> (genType const &amp;x)</td></tr>
    64. 

  64. <tr class="separator:gadeda850d5dff43d4d069854b1b6a623c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem:gace62d5d164def52455aeff19e1bccd88"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    66. 

  66. <tr class="memitem:gace62d5d164def52455aeff19e1bccd88"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#gace62d5d164def52455aeff19e1bccd88">cos</a> (genType const &amp;angle)</td></tr>
    67. 

  67. <tr class="separator:gace62d5d164def52455aeff19e1bccd88"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. <tr class="memitem:gaf1b20113fe439fa48524e8c35ea2c1d0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    69. 

  69. <tr class="memitem:gaf1b20113fe439fa48524e8c35ea2c1d0"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#gaf1b20113fe439fa48524e8c35ea2c1d0">cosh</a> (genType const &amp;angle)</td></tr>
    70. 

  70. <tr class="separator:gaf1b20113fe439fa48524e8c35ea2c1d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    71. 

  71. <tr class="memitem:ga034bdb53d458242c506e4d830c7df3aa"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    72. 

  72. <tr class="memitem:ga034bdb53d458242c506e4d830c7df3aa"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga034bdb53d458242c506e4d830c7df3aa">degrees</a> (genType const &amp;radians)</td></tr>
    73. 

  73. <tr class="separator:ga034bdb53d458242c506e4d830c7df3aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga4fb76e28851c9ff6653532566084e091"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    75. 

  75. <tr class="memitem:ga4fb76e28851c9ff6653532566084e091"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga4fb76e28851c9ff6653532566084e091">radians</a> (genType const &amp;degrees)</td></tr>
    76. 

  76. <tr class="separator:ga4fb76e28851c9ff6653532566084e091"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. <tr class="memitem:ga4fcd05daafb008f20e121e727c0196c7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    78. 

  78. <tr class="memitem:ga4fcd05daafb008f20e121e727c0196c7"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga4fcd05daafb008f20e121e727c0196c7">sin</a> (genType const &amp;angle)</td></tr>
    79. 

  79. <tr class="separator:ga4fcd05daafb008f20e121e727c0196c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ga6f38bb1a343b5d73ac71ddd53baa3375"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    81. 

  81. <tr class="memitem:ga6f38bb1a343b5d73ac71ddd53baa3375"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga6f38bb1a343b5d73ac71ddd53baa3375">sinh</a> (genType const &amp;angle)</td></tr>
    82. 

  82. <tr class="separator:ga6f38bb1a343b5d73ac71ddd53baa3375"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem:ga43860bed05c85587e2d931b26d765640"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    84. 

  84. <tr class="memitem:ga43860bed05c85587e2d931b26d765640"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga43860bed05c85587e2d931b26d765640">tan</a> (genType const &amp;angle)</td></tr>
    85. 

  85. <tr class="separator:ga43860bed05c85587e2d931b26d765640"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:ga5315f571fd52f30d368abc056c4aea13"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    87. 

  87. <tr class="memitem:ga5315f571fd52f30d368abc056c4aea13"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00136.html#ga5315f571fd52f30d368abc056c4aea13">tanh</a> (genType const &amp;angle)</td></tr>
    88. 

  88. <tr class="separator:ga5315f571fd52f30d368abc056c4aea13"><td class="memSeparator" colspan="2">&#160;</td></tr>
    89. 

  89. </table>
    90. 

  90. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    91. 

  91. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
    92. 

  92. <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>
    93. 

  93. <p>These all operate component-wise. The description is per component. </p>
    94. 

  94. <h2 class="groupheader">Function Documentation</h2>
    95. 

  95. <a class="anchor" id="gafef7954b5fa3228f4aaabde8dfa862a1"></a>
    96. 

  96. <div class="memitem">
    97. 

  97. <div class="memproto">
    98. 

  98.       <table class="memname">
    99. 

  99.         <tr>
    100. 

  100.           <td class="memname">genType glm::acos </td>
    101. 

  101.           <td>(</td>
    102. 

  102.           <td class="paramtype">genType const &amp;&#160;</td>
    103. 

  103.           <td class="paramname"><em>x</em></td><td>)</td>
    104. 

  104.           <td></td>
    105. 

  105.         </tr>
    106. 

  106.       </table>
    107. 

  107. </div><div class="memdoc">
    108. 

  108. 

  109. <p>Arc cosine. </p>
    110. 

  110. <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>
    111. 

  111. <dl class="tparams"><dt>Template Parameters</dt><dd>
    112. 

  112.   <table class="tparams">
    113. 

  113.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    114. 

  114.   </table>
    115. 

  115.   </dd>
    116. 

  116. </dl>
    117. 

  117. <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>
    118. 

  118. <dd>
    119. 

  119. <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>
    120. 

  120. 

  121. </div>
    122. 

  122. </div>
    123. 

  123. <a class="anchor" id="ga0f37ff6b6878a0169cd41249e5377e09"></a>
    124. 

  124. <div class="memitem">
    125. 

  125. <div class="memproto">
    126. 

  126.       <table class="memname">
    127. 

  127.         <tr>
    128. 

  128.           <td class="memname">genType glm::acosh </td>
    129. 

  129.           <td>(</td>
    130. 

  130.           <td class="paramtype">genType const &amp;&#160;</td>
    131. 

  131.           <td class="paramname"><em>x</em></td><td>)</td>
    132. 

  132.           <td></td>
    133. 

  133.         </tr>
    134. 

  134.       </table>
    135. 

  135. </div><div class="memdoc">
    136. 

  136. 

  137. <p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p>
    138. 

  138. <p>Results are undefined if x &lt; 1.</p>
    139. 

  139. <dl class="tparams"><dt>Template Parameters</dt><dd>
    140. 

  140.   <table class="tparams">
    141. 

  141.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    142. 

  142.   </table>
    143. 

  143.   </dd>
    144. 

  144. </dl>
    145. 

  145. <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>
    146. 

  146. <dd>
    147. 

  147. <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>
    148. 

  148. 

  149. </div>
    150. 

  150. </div>
    151. 

  151. <a class="anchor" id="ga76b6422e62c99fa0849abdf21fcef5cf"></a>
    152. 

  152. <div class="memitem">
    153. 

  153. <div class="memproto">
    154. 

  154.       <table class="memname">
    155. 

  155.         <tr>
    156. 

  156.           <td class="memname">genType glm::asin </td>
    157. 

  157.           <td>(</td>
    158. 

  158.           <td class="paramtype">genType const &amp;&#160;</td>
    159. 

  159.           <td class="paramname"><em>x</em></td><td>)</td>
    160. 

  160.           <td></td>
    161. 

  161.         </tr>
    162. 

  162.       </table>
    163. 

  163. </div><div class="memdoc">
    164. 

  164. 

  165. <p>Arc sine. </p>
    166. 

  166. <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>
    167. 

  167. <dl class="tparams"><dt>Template Parameters</dt><dd>
    168. 

  168.   <table class="tparams">
    169. 

  169.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    170. 

  170.   </table>
    171. 

  171.   </dd>
    172. 

  172. </dl>
    173. 

  173. <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>
    174. 

  174. <dd>
    175. 

  175. <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>
    176. 

  176. 

  177. </div>
    178. 

  178. </div>
    179. 

  179. <a class="anchor" id="ga615d386dcfb41cdbbca2609c53113aac"></a>
    180. 

  180. <div class="memitem">
    181. 

  181. <div class="memproto">
    182. 

  182.       <table class="memname">
    183. 

  183.         <tr>
    184. 

  184.           <td class="memname">genType glm::asinh </td>
    185. 

  185.           <td>(</td>
    186. 

  186.           <td class="paramtype">genType const &amp;&#160;</td>
    187. 

  187.           <td class="paramname"><em>x</em></td><td>)</td>
    188. 

  188.           <td></td>
    189. 

  189.         </tr>
    190. 

  190.       </table>
    191. 

  191. </div><div class="memdoc">
    192. 

  192. 

  193. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
    194. 

  194. <dl class="tparams"><dt>Template Parameters</dt><dd>
    195. 

  195.   <table class="tparams">
    196. 

  196.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    197. 

  197.   </table>
    198. 

  198.   </dd>
    199. 

  199. </dl>
    200. 

  200. <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>
    201. 

  201. <dd>
    202. 

  202. <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>
    203. 

  203. 

  204. </div>
    205. 

  205. </div>
    206. 

  206. <a class="anchor" id="ga2394d11075a74869cd88473c76722bc8"></a>
    207. 

  207. <div class="memitem">
    208. 

  208. <div class="memproto">
    209. 

  209.       <table class="memname">
    210. 

  210.         <tr>
    211. 

  211.           <td class="memname">genType glm::atan </td>
    212. 

  212.           <td>(</td>
    213. 

  213.           <td class="paramtype">genType const &amp;&#160;</td>
    214. 

  214.           <td class="paramname"><em>y</em>, </td>
    215. 

  215.         </tr>
    216. 

  216.         <tr>
    217. 

  217.           <td class="paramkey"></td>
    218. 

  218.           <td></td>
    219. 

  219.           <td class="paramtype">genType const &amp;&#160;</td>
    220. 

  220.           <td class="paramname"><em>x</em>&#160;</td>
    221. 

  221.         </tr>
    222. 

  222.         <tr>
    223. 

  223.           <td></td>
    224. 

  224.           <td>)</td>
    225. 

  225.           <td></td><td></td>
    226. 

  226.         </tr>
    227. 

  227.       </table>
    228. 

  228. </div><div class="memdoc">
    229. 

  229. 

  230. <p>Arc tangent. </p>
    231. 

  231. <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>
    232. 

  232. <dl class="tparams"><dt>Template Parameters</dt><dd>
    233. 

  233.   <table class="tparams">
    234. 

  234.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    235. 

  235.   </table>
    236. 

  236.   </dd>
    237. 

  237. </dl>
    238. 

  238. <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>
    239. 

  239. <dd>
    240. 

  240. <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>
    241. 

  241. 

  242. <p>Referenced by <a class="el" href="a00013_source.html#l00080">glm::atan2()</a>.</p>
    243. 

  243. 

  244. </div>
    245. 

  245. </div>
    246. 

  246. <a class="anchor" id="ga5db83034488156692939acb4f4e46fa6"></a>
    247. 

  247. <div class="memitem">
    248. 

  248. <div class="memproto">
    249. 

  249.       <table class="memname">
    250. 

  250.         <tr>
    251. 

  251.           <td class="memname">genType glm::atan </td>
    252. 

  252.           <td>(</td>
    253. 

  253.           <td class="paramtype">genType const &amp;&#160;</td>
    254. 

  254.           <td class="paramname"><em>y_over_x</em></td><td>)</td>
    255. 

  255.           <td></td>
    256. 

  256.         </tr>
    257. 

  257.       </table>
    258. 

  258. </div><div class="memdoc">
    259. 

  259. 

  260. <p>Arc tangent. </p>
    261. 

  261. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p>
    262. 

  262. <dl class="tparams"><dt>Template Parameters</dt><dd>
    263. 

  263.   <table class="tparams">
    264. 

  264.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    265. 

  265.   </table>
    266. 

  266.   </dd>
    267. 

  267. </dl>
    268. 

  268. <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>
    269. 

  269. <dd>
    270. 

  270. <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>
    271. 

  271. 

  272. </div>
    273. 

  273. </div>
    274. 

  274. <a class="anchor" id="gadeda850d5dff43d4d069854b1b6a623c"></a>
    275. 

  275. <div class="memitem">
    276. 

  276. <div class="memproto">
    277. 

  277.       <table class="memname">
    278. 

  278.         <tr>
    279. 

  279.           <td class="memname">genType glm::atanh </td>
    280. 

  280.           <td>(</td>
    281. 

  281.           <td class="paramtype">genType const &amp;&#160;</td>
    282. 

  282.           <td class="paramname"><em>x</em></td><td>)</td>
    283. 

  283.           <td></td>
    284. 

  284.         </tr>
    285. 

  285.       </table>
    286. 

  286. </div><div class="memdoc">
    287. 

  287. 

  288. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
    289. 

  289. <p>Results are undefined if abs(x) &gt;= 1.</p>
    290. 

  290. <dl class="tparams"><dt>Template Parameters</dt><dd>
    291. 

  291.   <table class="tparams">
    292. 

  292.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    293. 

  293.   </table>
    294. 

  294.   </dd>
    295. 

  295. </dl>
    296. 

  296. <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>
    297. 

  297. <dd>
    298. 

  298. <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>
    299. 

  299. 

  300. </div>
    301. 

  301. </div>
    302. 

  302. <a class="anchor" id="gace62d5d164def52455aeff19e1bccd88"></a>
    303. 

  303. <div class="memitem">
    304. 

  304. <div class="memproto">
    305. 

  305.       <table class="memname">
    306. 

  306.         <tr>
    307. 

  307.           <td class="memname">genType glm::cos </td>
    308. 

  308.           <td>(</td>
    309. 

  309.           <td class="paramtype">genType const &amp;&#160;</td>
    310. 

  310.           <td class="paramname"><em>angle</em></td><td>)</td>
    311. 

  311.           <td></td>
    312. 

  312.         </tr>
    313. 

  313.       </table>
    314. 

  314. </div><div class="memdoc">
    315. 

  315. 

  316. <p>The standard trigonometric cosine function. </p>
    317. 

  317. <p>The values returned by this function will range from [-1, 1].</p>
    318. 

  318. <dl class="tparams"><dt>Template Parameters</dt><dd>
    319. 

  319.   <table class="tparams">
    320. 

  320.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    321. 

  321.   </table>
    322. 

  322.   </dd>
    323. 

  323. </dl>
    324. 

  324. <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>
    325. 

  325. <dd>
    326. 

  326. <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>
    327. 

  327. 

  328. </div>
    329. 

  329. </div>
    330. 

  330. <a class="anchor" id="gaf1b20113fe439fa48524e8c35ea2c1d0"></a>
    331. 

  331. <div class="memitem">
    332. 

  332. <div class="memproto">
    333. 

  333.       <table class="memname">
    334. 

  334.         <tr>
    335. 

  335.           <td class="memname">genType glm::cosh </td>
    336. 

  336.           <td>(</td>
    337. 

  337.           <td class="paramtype">genType const &amp;&#160;</td>
    338. 

  338.           <td class="paramname"><em>angle</em></td><td>)</td>
    339. 

  339.           <td></td>
    340. 

  340.         </tr>
    341. 

  341.       </table>
    342. 

  342. </div><div class="memdoc">
    343. 

  343. 

  344. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
    345. 

  345. <dl class="tparams"><dt>Template Parameters</dt><dd>
    346. 

  346.   <table class="tparams">
    347. 

  347.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    348. 

  348.   </table>
    349. 

  349.   </dd>
    350. 

  350. </dl>
    351. 

  351. <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>
    352. 

  352. <dd>
    353. 

  353. <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>
    354. 

  354. 

  355. </div>
    356. 

  356. </div>
    357. 

  357. <a class="anchor" id="ga034bdb53d458242c506e4d830c7df3aa"></a>
    358. 

  358. <div class="memitem">
    359. 

  359. <div class="memproto">
    360. 

  360.       <table class="memname">
    361. 

  361.         <tr>
    362. 

  362.           <td class="memname">genType glm::degrees </td>
    363. 

  363.           <td>(</td>
    364. 

  364.           <td class="paramtype">genType const &amp;&#160;</td>
    365. 

  365.           <td class="paramname"><em>radians</em></td><td>)</td>
    366. 

  366.           <td></td>
    367. 

  367.         </tr>
    368. 

  368.       </table>
    369. 

  369. </div><div class="memdoc">
    370. 

  370. 

  371. <p>Converts radians to degrees and returns the result. </p>
    372. 

  372. <dl class="tparams"><dt>Template Parameters</dt><dd>
    373. 

  373.   <table class="tparams">
    374. 

  374.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    375. 

  375.   </table>
    376. 

  376.   </dd>
    377. 

  377. </dl>
    378. 

  378. <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>
    379. 

  379. <dd>
    380. 

  380. <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>
    381. 

  381. 

  382. </div>
    383. 

  383. </div>
    384. 

  384. <a class="anchor" id="ga4fb76e28851c9ff6653532566084e091"></a>
    385. 

  385. <div class="memitem">
    386. 

  386. <div class="memproto">
    387. 

  387.       <table class="memname">
    388. 

  388.         <tr>
    389. 

  389.           <td class="memname">genType glm::radians </td>
    390. 

  390.           <td>(</td>
    391. 

  391.           <td class="paramtype">genType const &amp;&#160;</td>
    392. 

  392.           <td class="paramname"><em>degrees</em></td><td>)</td>
    393. 

  393.           <td></td>
    394. 

  394.         </tr>
    395. 

  395.       </table>
    396. 

  396. </div><div class="memdoc">
    397. 

  397. 

  398. <p>Converts degrees to radians and returns the result. </p>
    399. 

  399. <dl class="tparams"><dt>Template Parameters</dt><dd>
    400. 

  400.   <table class="tparams">
    401. 

  401.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    402. 

  402.   </table>
    403. 

  403.   </dd>
    404. 

  404. </dl>
    405. 

  405. <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>
    406. 

  406. <dd>
    407. 

  407. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
    408. 

  408. 

  409. </div>
    410. 

  410. </div>
    411. 

  411. <a class="anchor" id="ga4fcd05daafb008f20e121e727c0196c7"></a>
    412. 

  412. <div class="memitem">
    413. 

  413. <div class="memproto">
    414. 

  414.       <table class="memname">
    415. 

  415.         <tr>
    416. 

  416.           <td class="memname">genType glm::sin </td>
    417. 

  417.           <td>(</td>
    418. 

  418.           <td class="paramtype">genType const &amp;&#160;</td>
    419. 

  419.           <td class="paramname"><em>angle</em></td><td>)</td>
    420. 

  420.           <td></td>
    421. 

  421.         </tr>
    422. 

  422.       </table>
    423. 

  423. </div><div class="memdoc">
    424. 

  424. 

  425. <p>The standard trigonometric sine function. </p>
    426. 

  426. <p>The values returned by this function will range from [-1, 1].</p>
    427. 

  427. <dl class="tparams"><dt>Template Parameters</dt><dd>
    428. 

  428.   <table class="tparams">
    429. 

  429.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    430. 

  430.   </table>
    431. 

  431.   </dd>
    432. 

  432. </dl>
    433. 

  433. <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>
    434. 

  434. <dd>
    435. 

  435. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl>
    436. 

  436. 

  437. </div>
    438. 

  438. </div>
    439. 

  439. <a class="anchor" id="ga6f38bb1a343b5d73ac71ddd53baa3375"></a>
    440. 

  440. <div class="memitem">
    441. 

  441. <div class="memproto">
    442. 

  442.       <table class="memname">
    443. 

  443.         <tr>
    444. 

  444.           <td class="memname">genType glm::sinh </td>
    445. 

  445.           <td>(</td>
    446. 

  446.           <td class="paramtype">genType const &amp;&#160;</td>
    447. 

  447.           <td class="paramname"><em>angle</em></td><td>)</td>
    448. 

  448.           <td></td>
    449. 

  449.         </tr>
    450. 

  450.       </table>
    451. 

  451. </div><div class="memdoc">
    452. 

  452. 

  453. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
    454. 

  454. <dl class="tparams"><dt>Template Parameters</dt><dd>
    455. 

  455.   <table class="tparams">
    456. 

  456.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    457. 

  457.   </table>
    458. 

  458.   </dd>
    459. 

  459. </dl>
    460. 

  460. <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>
    461. 

  461. <dd>
    462. 

  462. <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>
    463. 

  463. 

  464. </div>
    465. 

  465. </div>
    466. 

  466. <a class="anchor" id="ga43860bed05c85587e2d931b26d765640"></a>
    467. 

  467. <div class="memitem">
    468. 

  468. <div class="memproto">
    469. 

  469.       <table class="memname">
    470. 

  470.         <tr>
    471. 

  471.           <td class="memname">genType glm::tan </td>
    472. 

  472.           <td>(</td>
    473. 

  473.           <td class="paramtype">genType const &amp;&#160;</td>
    474. 

  474.           <td class="paramname"><em>angle</em></td><td>)</td>
    475. 

  475.           <td></td>
    476. 

  476.         </tr>
    477. 

  477.       </table>
    478. 

  478. </div><div class="memdoc">
    479. 

  479. 

  480. <p>The standard trigonometric tangent function. </p>
    481. 

  481. <dl class="tparams"><dt>Template Parameters</dt><dd>
    482. 

  482.   <table class="tparams">
    483. 

  483.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    484. 

  484.   </table>
    485. 

  485.   </dd>
    486. 

  486. </dl>
    487. 

  487. <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>
    488. 

  488. <dd>
    489. 

  489. <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>
    490. 

  490. 

  491. </div>
    492. 

  492. </div>
    493. 

  493. <a class="anchor" id="ga5315f571fd52f30d368abc056c4aea13"></a>
    494. 

  494. <div class="memitem">
    495. 

  495. <div class="memproto">
    496. 

  496.       <table class="memname">
    497. 

  497.         <tr>
    498. 

  498.           <td class="memname">genType glm::tanh </td>
    499. 

  499.           <td>(</td>
    500. 

  500.           <td class="paramtype">genType const &amp;&#160;</td>
    501. 

  501.           <td class="paramname"><em>angle</em></td><td>)</td>
    502. 

  502.           <td></td>
    503. 

  503.         </tr>
    504. 

  504.       </table>
    505. 

  505. </div><div class="memdoc">
    506. 

  506. 

  507. <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
    508. 

  508. <dl class="tparams"><dt>Template Parameters</dt><dd>
    509. 

  509.   <table class="tparams">
    510. 

  510.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    511. 

  511.   </table>
    512. 

  512.   </dd>
    513. 

  513. </dl>
    514. 

  514. <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>
    515. 

  515. <dd>
    516. 

  516. <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>
    517. 

  517. 

  518. </div>
    519. 

  519. </div>
    520. 

  520. </div><!-- contents -->
    521. 

  521. <!-- start footer part -->
    522. 

  522. <hr class="footer"/><address class="footer"><small>
    523. 

  523. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    524. 

  524. <img class="footer" src="doxygen.png" alt="doxygen"/>
    525. 

  525. </a> 1.8.2
    526. 

  526. </small></address>
    527. 

  527. </body>
    528. 

  528. </html>
    529.