Platformer in OpenGL
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

366 lines
18 KiB

5 years ago
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>0.9.9 API documenation: Exponential functions</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">0.9.9 API documenation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.14 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Exponential functions<div class="ingroups"><a class="el" href="a00698.html">Core features</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:ga071566cadc7505455e611f2a0353f4d4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:ga071566cadc7505455e611f2a0353f4d4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#ga071566cadc7505455e611f2a0353f4d4">exp</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  74. <tr class="separator:ga071566cadc7505455e611f2a0353f4d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:gaff17ace6b579a03bf223ed4d1ed2cd16"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  76. <tr class="memitem:gaff17ace6b579a03bf223ed4d1ed2cd16"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#gaff17ace6b579a03bf223ed4d1ed2cd16">exp2</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  77. <tr class="separator:gaff17ace6b579a03bf223ed4d1ed2cd16"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga523dd6bd0ad9f75ae2d24c8e4b017b7a"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  79. <tr class="memitem:ga523dd6bd0ad9f75ae2d24c8e4b017b7a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#ga523dd6bd0ad9f75ae2d24c8e4b017b7a">inversesqrt</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  80. <tr class="separator:ga523dd6bd0ad9f75ae2d24c8e4b017b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga918c9f3fd086ce20e6760c903bd30fa9"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  82. <tr class="memitem:ga918c9f3fd086ce20e6760c903bd30fa9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#ga918c9f3fd086ce20e6760c903bd30fa9">log</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  83. <tr class="separator:ga918c9f3fd086ce20e6760c903bd30fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga82831c7d9cca777cebedfe03a19c8d75"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:ga82831c7d9cca777cebedfe03a19c8d75"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#ga82831c7d9cca777cebedfe03a19c8d75">log2</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  86. <tr class="separator:ga82831c7d9cca777cebedfe03a19c8d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ga2254981952d4f333b900a6bf5167a6c4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:ga2254981952d4f333b900a6bf5167a6c4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#ga2254981952d4f333b900a6bf5167a6c4">pow</a> (vec&lt; L, T, Q &gt; const &amp;base, vec&lt; L, T, Q &gt; const &amp;exponent)</td></tr>
  89. <tr class="separator:ga2254981952d4f333b900a6bf5167a6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:gaa83e5f1648b7ccdf33b87c07c76cb77c"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  91. <tr class="memitem:gaa83e5f1648b7ccdf33b87c07c76cb77c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00664.html#gaa83e5f1648b7ccdf33b87c07c76cb77c">sqrt</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  92. <tr class="separator:gaa83e5f1648b7ccdf33b87c07c76cb77c"><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>Provides GLSL exponential functions. </p>
  96. <p>These all operate component-wise. The description is per component.</p>
  97. <p>Include &lt;<a class="el" href="a00080.html" title="Core features ">glm/exponential.hpp</a>&gt; to use these core features. </p>
  98. <h2 class="groupheader">Function Documentation</h2>
  99. <a id="ga071566cadc7505455e611f2a0353f4d4"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#ga071566cadc7505455e611f2a0353f4d4">&#9670;&nbsp;</a></span>exp()</h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::exp </td>
  106. <td>(</td>
  107. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  108. <td class="paramname"><em>v</em></td><td>)</td>
  109. <td></td>
  110. </tr>
  111. </table>
  112. </div><div class="memdoc">
  113. <p>Returns the natural exponentiation of x, i.e., e^x. </p>
  114. <dl class="params"><dt>Parameters</dt><dd>
  115. <table class="params">
  116. <tr><td class="paramname">v</td><td>exp function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
  117. </table>
  118. </dd>
  119. </dl>
  120. <dl class="tparams"><dt>Template Parameters</dt><dd>
  121. <table class="tparams">
  122. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  123. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  124. </table>
  125. </dd>
  126. </dl>
  127. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a> </dd>
  128. <dd>
  129. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  130. </div>
  131. </div>
  132. <a id="gaff17ace6b579a03bf223ed4d1ed2cd16"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#gaff17ace6b579a03bf223ed4d1ed2cd16">&#9670;&nbsp;</a></span>exp2()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::exp2 </td>
  139. <td>(</td>
  140. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  141. <td class="paramname"><em>v</em></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Returns 2 raised to the v power. </p>
  147. <dl class="params"><dt>Parameters</dt><dd>
  148. <table class="params">
  149. <tr><td class="paramname">v</td><td>exp2 function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
  150. </table>
  151. </dd>
  152. </dl>
  153. <dl class="tparams"><dt>Template Parameters</dt><dd>
  154. <table class="tparams">
  155. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  156. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  157. </table>
  158. </dd>
  159. </dl>
  160. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a> </dd>
  161. <dd>
  162. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  163. </div>
  164. </div>
  165. <a id="ga523dd6bd0ad9f75ae2d24c8e4b017b7a"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#ga523dd6bd0ad9f75ae2d24c8e4b017b7a">&#9670;&nbsp;</a></span>inversesqrt()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::inversesqrt </td>
  172. <td>(</td>
  173. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  174. <td class="paramname"><em>v</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Returns the reciprocal of the positive square root of v. </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">v</td><td>inversesqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type qualifier. </td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="tparams"><dt>Template Parameters</dt><dd>
  187. <table class="tparams">
  188. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  189. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  190. </table>
  191. </dd>
  192. </dl>
  193. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a> </dd>
  194. <dd>
  195. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  196. </div>
  197. </div>
  198. <a id="ga918c9f3fd086ce20e6760c903bd30fa9"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#ga918c9f3fd086ce20e6760c903bd30fa9">&#9670;&nbsp;</a></span>log()</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::log </td>
  205. <td>(</td>
  206. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  207. <td class="paramname"><em>v</em></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Returns the natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. </p>
  213. <p>Results are undefined if v &lt;= 0.</p>
  214. <dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramname">v</td><td>log function is defined for input values of v defined in the range (0, inf+) in the limit of the type qualifier. </td></tr>
  217. </table>
  218. </dd>
  219. </dl>
  220. <dl class="tparams"><dt>Template Parameters</dt><dd>
  221. <table class="tparams">
  222. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  223. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  224. </table>
  225. </dd>
  226. </dl>
  227. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a> </dd>
  228. <dd>
  229. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a id="ga82831c7d9cca777cebedfe03a19c8d75"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#ga82831c7d9cca777cebedfe03a19c8d75">&#9670;&nbsp;</a></span>log2()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::log2 </td>
  239. <td>(</td>
  240. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  241. <td class="paramname"><em>v</em></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
  247. <dl class="params"><dt>Parameters</dt><dd>
  248. <table class="params">
  249. <tr><td class="paramname">v</td><td>log2 function is defined for input values of v defined in the range (0, inf+) in the limit of the type qualifier. </td></tr>
  250. </table>
  251. </dd>
  252. </dl>
  253. <dl class="tparams"><dt>Template Parameters</dt><dd>
  254. <table class="tparams">
  255. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  256. <tr><td class="paramname">T</td><td>Floating-point scalar 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/log2.xml">GLSL log2 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.2 Exponential Functions</a> </dd></dl>
  263. </div>
  264. </div>
  265. <a id="ga2254981952d4f333b900a6bf5167a6c4"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#ga2254981952d4f333b900a6bf5167a6c4">&#9670;&nbsp;</a></span>pow()</h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::pow </td>
  272. <td>(</td>
  273. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  274. <td class="paramname"><em>base</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  280. <td class="paramname"><em>exponent</em>&#160;</td>
  281. </tr>
  282. <tr>
  283. <td></td>
  284. <td>)</td>
  285. <td></td><td></td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Returns 'base' raised to the power 'exponent'. </p>
  290. <dl class="params"><dt>Parameters</dt><dd>
  291. <table class="params">
  292. <tr><td class="paramname">base</td><td>Floating point value. pow function is defined for input values of 'base' defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
  293. <tr><td class="paramname">exponent</td><td>Floating point value representing the 'exponent'.</td></tr>
  294. </table>
  295. </dd>
  296. </dl>
  297. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a> </dd>
  298. <dd>
  299. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  300. </div>
  301. </div>
  302. <a id="gaa83e5f1648b7ccdf33b87c07c76cb77c"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#gaa83e5f1648b7ccdf33b87c07c76cb77c">&#9670;&nbsp;</a></span>sqrt()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::sqrt </td>
  309. <td>(</td>
  310. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  311. <td class="paramname"><em>v</em></td><td>)</td>
  312. <td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Returns the positive square root of v. </p>
  317. <dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramname">v</td><td>sqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type qualifier. </td></tr>
  320. </table>
  321. </dd>
  322. </dl>
  323. <dl class="tparams"><dt>Template Parameters</dt><dd>
  324. <table class="tparams">
  325. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  326. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a> </dd>
  331. <dd>
  332. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  333. </div>
  334. </div>
  335. </div><!-- contents -->
  336. <!-- start footer part -->
  337. <hr class="footer"/><address class="footer"><small>
  338. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  339. <img class="footer" src="doxygen.png" alt="doxygen"/>
  340. </a> 1.8.14
  341. </small></address>
  342. </body>
  343. </html>