2
0

a00151.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  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.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documenation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00155.html">GLM Core</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Function parameters specified as angle are assumed to be in units of radians.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <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>
  88. <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="a00151.html#ga58ad259b788528fe0a4bd2eeb5e381cc">acos</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  89. <tr class="memdesc:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc cosine. <a href="a00151.html#ga58ad259b788528fe0a4bd2eeb5e381cc">More...</a><br /></td></tr>
  90. <tr class="separator:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <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="a00151.html#ga3f368ad3e1883b60748ca2634d816104">acosh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  93. <tr class="memdesc:ga3f368ad3e1883b60748ca2634d816104"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic cosine; returns the non-negative inverse of cosh. <a href="a00151.html#ga3f368ad3e1883b60748ca2634d816104">More...</a><br /></td></tr>
  94. <tr class="separator:ga3f368ad3e1883b60748ca2634d816104"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <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="a00151.html#ga88e29b8289e882859d76a25798dd9490">asin</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  97. <tr class="memdesc:ga88e29b8289e882859d76a25798dd9490"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc sine. <a href="a00151.html#ga88e29b8289e882859d76a25798dd9490">More...</a><br /></td></tr>
  98. <tr class="separator:ga88e29b8289e882859d76a25798dd9490"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <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="a00151.html#ga72bf44c1984e1afb63acf821ba33cac7">asinh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  101. <tr class="memdesc:ga72bf44c1984e1afb63acf821ba33cac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic sine; returns the inverse of sinh. <a href="a00151.html#ga72bf44c1984e1afb63acf821ba33cac7">More...</a><br /></td></tr>
  102. <tr class="separator:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <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="a00151.html#ga461e769acb8b8cb695a5a89334546611">atan</a> (vecType&lt; T, P &gt; const &amp;y, vecType&lt; T, P &gt; const &amp;x)</td></tr>
  105. <tr class="memdesc:ga461e769acb8b8cb695a5a89334546611"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent. <a href="a00151.html#ga461e769acb8b8cb695a5a89334546611">More...</a><br /></td></tr>
  106. <tr class="separator:ga461e769acb8b8cb695a5a89334546611"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <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="a00151.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a> (vecType&lt; T, P &gt; const &amp;y_over_x)</td></tr>
  109. <tr class="memdesc:gae8f22458bba8f2321ceb1bfc4a543216"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent. <a href="a00151.html#gae8f22458bba8f2321ceb1bfc4a543216">More...</a><br /></td></tr>
  110. <tr class="separator:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <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="a00151.html#gaffa8decdd8620759f4e6fe4834768b87">atanh</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  113. <tr class="memdesc:gaffa8decdd8620759f4e6fe4834768b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc hyperbolic tangent; returns the inverse of tanh. <a href="a00151.html#gaffa8decdd8620759f4e6fe4834768b87">More...</a><br /></td></tr>
  114. <tr class="separator:gaffa8decdd8620759f4e6fe4834768b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <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="a00151.html#ga728fd86f14609e37d83f82429995b7b3">cos</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  117. <tr class="memdesc:ga728fd86f14609e37d83f82429995b7b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric cosine function. <a href="a00151.html#ga728fd86f14609e37d83f82429995b7b3">More...</a><br /></td></tr>
  118. <tr class="separator:ga728fd86f14609e37d83f82429995b7b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <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="a00151.html#ga660582a4e5e843b6c1cd535777e8c295">cosh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  121. <tr class="memdesc:ga660582a4e5e843b6c1cd535777e8c295"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. <a href="a00151.html#ga660582a4e5e843b6c1cd535777e8c295">More...</a><br /></td></tr>
  122. <tr class="separator:ga660582a4e5e843b6c1cd535777e8c295"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  124. <tr class="memitem:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00151.html#gabccdcc282134fd62af0ff3d6e4bb21f1">degrees</a> (vecType&lt; T, P &gt; const &amp;radians)</td></tr>
  125. <tr class="memdesc:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts radians to degrees and returns the result. <a href="a00151.html#gabccdcc282134fd62af0ff3d6e4bb21f1">More...</a><br /></td></tr>
  126. <tr class="separator:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  128. <tr class="memitem:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00151.html#gafffb5e533f75318bdf4e0967d8a6c05c">radians</a> (vecType&lt; T, P &gt; const &amp;degrees)</td></tr>
  129. <tr class="memdesc:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts degrees to radians and returns the result. <a href="a00151.html#gafffb5e533f75318bdf4e0967d8a6c05c">More...</a><br /></td></tr>
  130. <tr class="separator:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <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="a00151.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">sin</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  133. <tr class="memdesc:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric sine function. <a href="a00151.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">More...</a><br /></td></tr>
  134. <tr class="separator:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <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="a00151.html#gad8f89c12efe6f8d3ae8046625b266254">sinh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  137. <tr class="memdesc:gad8f89c12efe6f8d3ae8046625b266254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. <a href="a00151.html#gad8f89c12efe6f8d3ae8046625b266254">More...</a><br /></td></tr>
  138. <tr class="separator:gad8f89c12efe6f8d3ae8046625b266254"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <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="a00151.html#gab3ae890c38b7d3aa4d5e00998fd296b2">tan</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  141. <tr class="memdesc:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The standard trigonometric tangent function. <a href="a00151.html#gab3ae890c38b7d3aa4d5e00998fd296b2">More...</a><br /></td></tr>
  142. <tr class="separator:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <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="a00151.html#ga234e904a0075f88654a594b5f837711f">tanh</a> (vecType&lt; T, P &gt; const &amp;angle)</td></tr>
  145. <tr class="memdesc:ga234e904a0075f88654a594b5f837711f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) <a href="a00151.html#ga234e904a0075f88654a594b5f837711f">More...</a><br /></td></tr>
  146. <tr class="separator:ga234e904a0075f88654a594b5f837711f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  149. <p>Function parameters specified as angle are assumed to be in units of radians. </p>
  150. <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>
  151. <p>These all operate component-wise. The description is per component. </p>
  152. <h2 class="groupheader">Function Documentation</h2>
  153. <a class="anchor" id="ga58ad259b788528fe0a4bd2eeb5e381cc"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acos </td>
  159. <td>(</td>
  160. <td class="paramtype">vecType&lt; T, P &gt; 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 cosine. </p>
  167. <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>
  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/acos.xml">GLSL acos 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="ga3f368ad3e1883b60748ca2634d816104"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::acosh </td>
  185. <td>(</td>
  186. <td class="paramtype">vecType&lt; T, P &gt; 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 cosine; returns the non-negative inverse of cosh. </p>
  193. <p>Results are undefined if x &lt; 1.</p>
  194. <dl class="tparams"><dt>Template Parameters</dt><dd>
  195. <table class="tparams">
  196. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200. <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>
  201. <dd>
  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. </div>
  204. </div>
  205. <a class="anchor" id="ga88e29b8289e882859d76a25798dd9490"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asin </td>
  211. <td>(</td>
  212. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  213. <td class="paramname"><em>x</em></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Arc sine. </p>
  219. <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>
  220. <dl class="tparams"><dt>Template Parameters</dt><dd>
  221. <table class="tparams">
  222. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  223. </table>
  224. </dd>
  225. </dl>
  226. <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>
  227. <dd>
  228. <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>
  229. </div>
  230. </div>
  231. <a class="anchor" id="ga72bf44c1984e1afb63acf821ba33cac7"></a>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::asinh </td>
  237. <td>(</td>
  238. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  239. <td class="paramname"><em>x</em></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. <p>Arc hyperbolic sine; returns the inverse of sinh. </p>
  245. <dl class="tparams"><dt>Template Parameters</dt><dd>
  246. <table class="tparams">
  247. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  248. </table>
  249. </dd>
  250. </dl>
  251. <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>
  252. <dd>
  253. <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>
  254. </div>
  255. </div>
  256. <a class="anchor" id="ga461e769acb8b8cb695a5a89334546611"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
  262. <td>(</td>
  263. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  264. <td class="paramname"><em>y</em>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  270. <td class="paramname"><em>x</em>&#160;</td>
  271. </tr>
  272. <tr>
  273. <td></td>
  274. <td>)</td>
  275. <td></td><td></td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Arc tangent. </p>
  280. <p>Returns an angle whose tangent is y/x. The signs of x and y are used to determine what quadrant the angle is in. The range of values returned by this function is [-PI, PI]. Results are undefined if x and y are both 0.</p>
  281. <dl class="tparams"><dt>Template Parameters</dt><dd>
  282. <table class="tparams">
  283. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  284. </table>
  285. </dd>
  286. </dl>
  287. <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>
  288. <dd>
  289. <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>
  290. <p>Referenced by <a class="el" href="a00017_source.html#l00055">glm::atan2()</a>.</p>
  291. </div>
  292. </div>
  293. <a class="anchor" id="gae8f22458bba8f2321ceb1bfc4a543216"></a>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atan </td>
  299. <td>(</td>
  300. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  301. <td class="paramname"><em>y_over_x</em></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Arc tangent. </p>
  307. <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</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/atan.xml">GLSL atan 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="gaffa8decdd8620759f4e6fe4834768b87"></a>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::atanh </td>
  325. <td>(</td>
  326. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  327. <td class="paramname"><em>x</em></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Arc hyperbolic tangent; returns the inverse of tanh. </p>
  333. <p>Results are undefined if abs(x) &gt;= 1.</p>
  334. <dl class="tparams"><dt>Template Parameters</dt><dd>
  335. <table class="tparams">
  336. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  337. </table>
  338. </dd>
  339. </dl>
  340. <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>
  341. <dd>
  342. <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>
  343. </div>
  344. </div>
  345. <a class="anchor" id="ga728fd86f14609e37d83f82429995b7b3"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cos </td>
  351. <td>(</td>
  352. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  353. <td class="paramname"><em>angle</em></td><td>)</td>
  354. <td></td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>The standard trigonometric cosine function. </p>
  359. <p>The values returned by this function will range from [-1, 1].</p>
  360. <dl class="tparams"><dt>Template Parameters</dt><dd>
  361. <table class="tparams">
  362. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. <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>
  367. <dd>
  368. <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>
  369. </div>
  370. </div>
  371. <a class="anchor" id="ga660582a4e5e843b6c1cd535777e8c295"></a>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::cosh </td>
  377. <td>(</td>
  378. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  379. <td class="paramname"><em>angle</em></td><td>)</td>
  380. <td></td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p>
  385. <dl class="tparams"><dt>Template Parameters</dt><dd>
  386. <table class="tparams">
  387. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  388. </table>
  389. </dd>
  390. </dl>
  391. <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>
  392. <dd>
  393. <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>
  394. </div>
  395. </div>
  396. <a class="anchor" id="gabccdcc282134fd62af0ff3d6e4bb21f1"></a>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vecType&lt;T, P&gt; glm::degrees </td>
  402. <td>(</td>
  403. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  404. <td class="paramname"><em>radians</em></td><td>)</td>
  405. <td></td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Converts radians to degrees and returns the result. </p>
  410. <dl class="tparams"><dt>Template Parameters</dt><dd>
  411. <table class="tparams">
  412. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  413. </table>
  414. </dd>
  415. </dl>
  416. <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>
  417. <dd>
  418. <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>
  419. </div>
  420. </div>
  421. <a class="anchor" id="gafffb5e533f75318bdf4e0967d8a6c05c"></a>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vecType&lt;T, P&gt; glm::radians </td>
  427. <td>(</td>
  428. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  429. <td class="paramname"><em>degrees</em></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <p>Converts degrees to radians and returns the result. </p>
  435. <dl class="tparams"><dt>Template Parameters</dt><dd>
  436. <table class="tparams">
  437. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <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>
  442. <dd>
  443. <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>
  444. </div>
  445. </div>
  446. <a class="anchor" id="ga4a0ddceb6b1e64ce0e4da209dcb021d5"></a>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sin </td>
  452. <td>(</td>
  453. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  454. <td class="paramname"><em>angle</em></td><td>)</td>
  455. <td></td>
  456. </tr>
  457. </table>
  458. </div><div class="memdoc">
  459. <p>The standard trigonometric sine function. </p>
  460. <p>The values returned by this function will range from [-1, 1].</p>
  461. <dl class="tparams"><dt>Template Parameters</dt><dd>
  462. <table class="tparams">
  463. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  464. </table>
  465. </dd>
  466. </dl>
  467. <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>
  468. <dd>
  469. <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>
  470. </div>
  471. </div>
  472. <a class="anchor" id="gad8f89c12efe6f8d3ae8046625b266254"></a>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::sinh </td>
  478. <td>(</td>
  479. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  480. <td class="paramname"><em>angle</em></td><td>)</td>
  481. <td></td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p>
  486. <dl class="tparams"><dt>Template Parameters</dt><dd>
  487. <table class="tparams">
  488. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  489. </table>
  490. </dd>
  491. </dl>
  492. <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>
  493. <dd>
  494. <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>
  495. </div>
  496. </div>
  497. <a class="anchor" id="gab3ae890c38b7d3aa4d5e00998fd296b2"></a>
  498. <div class="memitem">
  499. <div class="memproto">
  500. <table class="memname">
  501. <tr>
  502. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tan </td>
  503. <td>(</td>
  504. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  505. <td class="paramname"><em>angle</em></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>The standard trigonometric tangent function. </p>
  511. <dl class="tparams"><dt>Template Parameters</dt><dd>
  512. <table class="tparams">
  513. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  514. </table>
  515. </dd>
  516. </dl>
  517. <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>
  518. <dd>
  519. <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>
  520. </div>
  521. </div>
  522. <a class="anchor" id="ga234e904a0075f88654a594b5f837711f"></a>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::tanh </td>
  528. <td>(</td>
  529. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  530. <td class="paramname"><em>angle</em></td><td>)</td>
  531. <td></td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p>
  536. <dl class="tparams"><dt>Template Parameters</dt><dd>
  537. <table class="tparams">
  538. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  539. </table>
  540. </dd>
  541. </dl>
  542. <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>
  543. <dd>
  544. <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>
  545. </div>
  546. </div>
  547. </div><!-- contents -->
  548. <!-- start footer part -->
  549. <hr class="footer"/><address class="footer"><small>
  550. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  551. <img class="footer" src="doxygen.png" alt="doxygen"/>
  552. </a> 1.8.10
  553. </small></address>
  554. </body>
  555. </html>