a00128.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  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. <title>GLM: glm::core::function::exponential Namespace Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.6.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15. <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  16. <li><a href="files.html"><span>Files</span></a></li>
  17. </ul>
  18. </div>
  19. <div class="tabs">
  20. <ul>
  21. <li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li>
  22. <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
  23. </ul>
  24. </div>
  25. <div class="navpath"><a class="el" href="a00124.html">glm</a>::<a class="el" href="a00125.html">core</a>::<a class="el" href="a00126.html">function</a>::<a class="el" href="a00128.html">exponential</a>
  26. </div>
  27. </div>
  28. <div class="contents">
  29. <h1>glm::core::function::exponential Namespace Reference</h1>
  30. <p>Define all <a class="el" href="a00128.html" title="Define all exponential functions from Section 8.2 of GLSL 1.30.8 specification. Included...">exponential</a> functions from Section 8.2 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace.
  31. <a href="#_details">More...</a></p>
  32. <table border="0" cellpadding="0" cellspacing="0">
  33. <tr><td colspan="2"><h2>Functions</h2></td></tr>
  34. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  35. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ac96b81360552e233031fd06390576ebf">exp</a> (genType const &amp;x)</td></tr>
  36. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the natural exponentiation of x, i.e., e^x. <a href="#ac96b81360552e233031fd06390576ebf"></a><br/></td></tr>
  37. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  38. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#a79adbdfa6f2e6ce59816c9b0bd1aebe3">exp2</a> (genType const &amp;x)</td></tr>
  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns 2 raised to the x power. <a href="#a79adbdfa6f2e6ce59816c9b0bd1aebe3"></a><br/></td></tr>
  40. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  41. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#adce520af7df2c97aea9f689ad620fabe">inversesqrt</a> (genType const &amp;x)</td></tr>
  42. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the reciprocal of the positive square root of x. <a href="#adce520af7df2c97aea9f689ad620fabe"></a><br/></td></tr>
  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  44. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#a50b7859bfe87c2f075fe7a04e4c68cc3">log</a> (genType const &amp;x)</td></tr>
  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. <a href="#a50b7859bfe87c2f075fe7a04e4c68cc3"></a><br/></td></tr>
  46. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  47. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#a956c24e59912196d4b3714789e57c077">log2</a> (genType const &amp;x)</td></tr>
  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. <a href="#a956c24e59912196d4b3714789e57c077"></a><br/></td></tr>
  49. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  50. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#a8eb76dfbf0fed3397c0327915279f06f">pow</a> (genType const &amp;x, genType const &amp;y)</td></tr>
  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns x raised to the y power. <a href="#a8eb76dfbf0fed3397c0327915279f06f"></a><br/></td></tr>
  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  53. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#a29d9d4ccbca8f2168ac6534fbb65cbad">sqrt</a> (genType const &amp;x)</td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the positive square root of x. <a href="#a29d9d4ccbca8f2168ac6534fbb65cbad"></a><br/></td></tr>
  55. </table>
  56. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  57. <p>Define all <a class="el" href="a00128.html" title="Define all exponential functions from Section 8.2 of GLSL 1.30.8 specification. Included...">exponential</a> functions from Section 8.2 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace. </p>
  58. <hr/><h2>Function Documentation</h2>
  59. <a class="anchor" id="ac96b81360552e233031fd06390576ebf"></a><!-- doxytag: member="glm::core::function::exponential::exp" ref="ac96b81360552e233031fd06390576ebf" args="(genType const &amp;x)" -->
  60. <div class="memitem">
  61. <div class="memproto">
  62. <table class="memname">
  63. <tr>
  64. <td class="memname">genType glm::core::function::exponential::exp </td>
  65. <td>(</td>
  66. <td class="paramtype">genType const &amp;&nbsp;</td>
  67. <td class="paramname"> <em>x</em></td>
  68. <td>&nbsp;)&nbsp;</td>
  69. <td></td>
  70. </tr>
  71. </table>
  72. </div>
  73. <div class="memdoc">
  74. <p>Returns the natural exponentiation of x, i.e., e^x. </p>
  75. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  76. </div>
  77. </div>
  78. <a class="anchor" id="a79adbdfa6f2e6ce59816c9b0bd1aebe3"></a><!-- doxytag: member="glm::core::function::exponential::exp2" ref="a79adbdfa6f2e6ce59816c9b0bd1aebe3" args="(genType const &amp;x)" -->
  79. <div class="memitem">
  80. <div class="memproto">
  81. <table class="memname">
  82. <tr>
  83. <td class="memname">genType glm::core::function::exponential::exp2 </td>
  84. <td>(</td>
  85. <td class="paramtype">genType const &amp;&nbsp;</td>
  86. <td class="paramname"> <em>x</em></td>
  87. <td>&nbsp;)&nbsp;</td>
  88. <td></td>
  89. </tr>
  90. </table>
  91. </div>
  92. <div class="memdoc">
  93. <p>Returns 2 raised to the x power. </p>
  94. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  95. </div>
  96. </div>
  97. <a class="anchor" id="adce520af7df2c97aea9f689ad620fabe"></a><!-- doxytag: member="glm::core::function::exponential::inversesqrt" ref="adce520af7df2c97aea9f689ad620fabe" args="(genType const &amp;x)" -->
  98. <div class="memitem">
  99. <div class="memproto">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">genType glm::core::function::exponential::inversesqrt </td>
  103. <td>(</td>
  104. <td class="paramtype">genType const &amp;&nbsp;</td>
  105. <td class="paramname"> <em>x</em></td>
  106. <td>&nbsp;)&nbsp;</td>
  107. <td></td>
  108. </tr>
  109. </table>
  110. </div>
  111. <div class="memdoc">
  112. <p>Returns the reciprocal of the positive square root of x. </p>
  113. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  114. </div>
  115. </div>
  116. <a class="anchor" id="a50b7859bfe87c2f075fe7a04e4c68cc3"></a><!-- doxytag: member="glm::core::function::exponential::log" ref="a50b7859bfe87c2f075fe7a04e4c68cc3" args="(genType const &amp;x)" -->
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">genType glm::core::function::exponential::log </td>
  122. <td>(</td>
  123. <td class="paramtype">genType const &amp;&nbsp;</td>
  124. <td class="paramname"> <em>x</em></td>
  125. <td>&nbsp;)&nbsp;</td>
  126. <td></td>
  127. </tr>
  128. </table>
  129. </div>
  130. <div class="memdoc">
  131. <p>Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. </p>
  132. <p>Results are undefined if x &lt;= 0. (From GLSL 1.30.08 specification, section 8.2) </p>
  133. </div>
  134. </div>
  135. <a class="anchor" id="a956c24e59912196d4b3714789e57c077"></a><!-- doxytag: member="glm::core::function::exponential::log2" ref="a956c24e59912196d4b3714789e57c077" args="(genType const &amp;x)" -->
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">genType glm::core::function::exponential::log2 </td>
  141. <td>(</td>
  142. <td class="paramtype">genType const &amp;&nbsp;</td>
  143. <td class="paramname"> <em>x</em></td>
  144. <td>&nbsp;)&nbsp;</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div>
  149. <div class="memdoc">
  150. <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
  151. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="a8eb76dfbf0fed3397c0327915279f06f"></a><!-- doxytag: member="glm::core::function::exponential::pow" ref="a8eb76dfbf0fed3397c0327915279f06f" args="(genType const &amp;x, genType const &amp;y)" -->
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">genType glm::core::function::exponential::pow </td>
  160. <td>(</td>
  161. <td class="paramtype">genType const &amp;&nbsp;</td>
  162. <td class="paramname"> <em>x</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">genType const &amp;&nbsp;</td>
  168. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  169. </tr>
  170. <tr>
  171. <td></td>
  172. <td>)</td>
  173. <td></td><td></td><td></td>
  174. </tr>
  175. </table>
  176. </div>
  177. <div class="memdoc">
  178. <p>Returns x raised to the y power. </p>
  179. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="a29d9d4ccbca8f2168ac6534fbb65cbad"></a><!-- doxytag: member="glm::core::function::exponential::sqrt" ref="a29d9d4ccbca8f2168ac6534fbb65cbad" args="(genType const &amp;x)" -->
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">genType glm::core::function::exponential::sqrt </td>
  188. <td>(</td>
  189. <td class="paramtype">genType const &amp;&nbsp;</td>
  190. <td class="paramname"> <em>x</em></td>
  191. <td>&nbsp;)&nbsp;</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div>
  196. <div class="memdoc">
  197. <p>Returns the positive square root of x. </p>
  198. <p>(From GLSL 1.30.08 specification, section 8.2) </p>
  199. </div>
  200. </div>
  201. </div>
  202. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
  203. <a href="http://www.doxygen.org/index.html">
  204. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  205. </body>
  206. </html>