a00203.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.7: GLM_GTX_integer</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.7
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#typedef-members">Typedefs</a> &#124;
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">GLM_GTX_integer<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  48. Typedefs</h2></td></tr>
  49. <tr class="memitem:gada7e83fdfe943aba4f1d5bf80cb66f40"><td class="memItemLeft" align="right" valign="top">typedef signed int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gada7e83fdfe943aba4f1d5bf80cb66f40">sint</a></td></tr>
  50. <tr class="separator:gada7e83fdfe943aba4f1d5bf80cb66f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. </table><table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  53. Functions</h2></td></tr>
  54. <tr class="memitem:ga8cbd3120905f398ec321b5d1836e08fb"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  55. <tr class="memitem:ga8cbd3120905f398ec321b5d1836e08fb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga8cbd3120905f398ec321b5d1836e08fb">factorial</a> (genType const &amp;x)</td></tr>
  56. <tr class="separator:ga8cbd3120905f398ec321b5d1836e08fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga7011b4e1c1e1ed492149b028feacc00e"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga7011b4e1c1e1ed492149b028feacc00e">floor_log2</a> (unsigned int x)</td></tr>
  58. <tr class="separator:ga7011b4e1c1e1ed492149b028feacc00e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gaabfbb41531ab7ad8d06fc176edfba785"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gaabfbb41531ab7ad8d06fc176edfba785">mod</a> (int x, int y)</td></tr>
  60. <tr class="separator:gaabfbb41531ab7ad8d06fc176edfba785"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ga63fc8d63e7da1706439233b386ba8b6f"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga63fc8d63e7da1706439233b386ba8b6f">mod</a> (uint x, uint y)</td></tr>
  62. <tr class="separator:ga63fc8d63e7da1706439233b386ba8b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga78dff8bdb361bf0061194c93e003d189"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga78dff8bdb361bf0061194c93e003d189">nlz</a> (uint x)</td></tr>
  64. <tr class="separator:ga78dff8bdb361bf0061194c93e003d189"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga89c591b970882714bd1e89a4e2f249f1"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga89c591b970882714bd1e89a4e2f249f1">pow</a> (int x, int y)</td></tr>
  66. <tr class="separator:ga89c591b970882714bd1e89a4e2f249f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ga998e5ee915d3769255519e2fbaa2bbf0"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga998e5ee915d3769255519e2fbaa2bbf0">pow</a> (uint x, uint y)</td></tr>
  68. <tr class="separator:ga998e5ee915d3769255519e2fbaa2bbf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga7ce36693a75879ccd9bb10167cfa722d"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga7ce36693a75879ccd9bb10167cfa722d">sqrt</a> (int x)</td></tr>
  70. <tr class="separator:ga7ce36693a75879ccd9bb10167cfa722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga1975d318978d6dacf78b6444fa5ed7bc"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga1975d318978d6dacf78b6444fa5ed7bc">sqrt</a> (uint x)</td></tr>
  72. <tr class="separator:ga1975d318978d6dacf78b6444fa5ed7bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. </table>
  74. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75. <p>Add support for integer for core functions. </p>
  76. <p>&lt;<a class="el" href="a00045.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
  77. <h2 class="groupheader">Typedef Documentation</h2>
  78. <a class="anchor" id="gada7e83fdfe943aba4f1d5bf80cb66f40"></a>
  79. <div class="memitem">
  80. <div class="memproto">
  81. <table class="memname">
  82. <tr>
  83. <td class="memname">typedef signed int sint</td>
  84. </tr>
  85. </table>
  86. </div><div class="memdoc">
  87. <p>32bit signed integer. </p>
  88. <p>From GLM_GTX_integer extension. </p>
  89. <p>Definition at line <a class="el" href="a00045_source.html#l00080">80</a> of file <a class="el" href="a00045_source.html">gtx/integer.hpp</a>.</p>
  90. </div>
  91. </div>
  92. <h2 class="groupheader">Function Documentation</h2>
  93. <a class="anchor" id="ga8cbd3120905f398ec321b5d1836e08fb"></a>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname">GLM_FUNC_DECL genType glm::factorial </td>
  99. <td>(</td>
  100. <td class="paramtype">genType const &amp;&#160;</td>
  101. <td class="paramname"><em>x</em></td><td>)</td>
  102. <td></td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension. </p>
  107. </div>
  108. </div>
  109. <a class="anchor" id="ga7011b4e1c1e1ed492149b028feacc00e"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">GLM_FUNC_DECL unsigned int glm::floor_log2 </td>
  115. <td>(</td>
  116. <td class="paramtype">unsigned int&#160;</td>
  117. <td class="paramname"><em>x</em></td><td>)</td>
  118. <td></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>Returns the floor log2 of x. </p>
  123. <p>From GLM_GTX_integer extension. </p>
  124. </div>
  125. </div>
  126. <a class="anchor" id="gaabfbb41531ab7ad8d06fc176edfba785"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">GLM_FUNC_DECL int glm::mod </td>
  132. <td>(</td>
  133. <td class="paramtype">int&#160;</td>
  134. <td class="paramname"><em>x</em>, </td>
  135. </tr>
  136. <tr>
  137. <td class="paramkey"></td>
  138. <td></td>
  139. <td class="paramtype">int&#160;</td>
  140. <td class="paramname"><em>y</em>&#160;</td>
  141. </tr>
  142. <tr>
  143. <td></td>
  144. <td>)</td>
  145. <td></td><td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Modulus. </p>
  150. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ga63fc8d63e7da1706439233b386ba8b6f"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL uint glm::mod </td>
  159. <td>(</td>
  160. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  161. <td class="paramname"><em>x</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  167. <td class="paramname"><em>y</em>&#160;</td>
  168. </tr>
  169. <tr>
  170. <td></td>
  171. <td>)</td>
  172. <td></td><td></td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Modulus. </p>
  177. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
  178. </div>
  179. </div>
  180. <a class="anchor" id="ga78dff8bdb361bf0061194c93e003d189"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">GLM_FUNC_DECL uint glm::nlz </td>
  186. <td>(</td>
  187. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  188. <td class="paramname"><em>x</em></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Returns the number of leading zeros. </p>
  194. <p>From GLM_GTX_integer extension. </p>
  195. </div>
  196. </div>
  197. <a class="anchor" id="ga89c591b970882714bd1e89a4e2f249f1"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">GLM_FUNC_DECL int glm::pow </td>
  203. <td>(</td>
  204. <td class="paramtype">int&#160;</td>
  205. <td class="paramname"><em>x</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">int&#160;</td>
  211. <td class="paramname"><em>y</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Returns x raised to the y power. </p>
  221. <p>From GLM_GTX_integer extension. </p>
  222. </div>
  223. </div>
  224. <a class="anchor" id="ga998e5ee915d3769255519e2fbaa2bbf0"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">GLM_FUNC_DECL uint glm::pow </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  232. <td class="paramname"><em>x</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  238. <td class="paramname"><em>y</em>&#160;</td>
  239. </tr>
  240. <tr>
  241. <td></td>
  242. <td>)</td>
  243. <td></td><td></td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Returns x raised to the y power. </p>
  248. <p>From GLM_GTX_integer extension. </p>
  249. </div>
  250. </div>
  251. <a class="anchor" id="ga7ce36693a75879ccd9bb10167cfa722d"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">GLM_FUNC_DECL int glm::sqrt </td>
  257. <td>(</td>
  258. <td class="paramtype">int&#160;</td>
  259. <td class="paramname"><em>x</em></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Returns the positive square root of x. </p>
  265. <p>From GLM_GTX_integer extension. </p>
  266. </div>
  267. </div>
  268. <a class="anchor" id="ga1975d318978d6dacf78b6444fa5ed7bc"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">GLM_FUNC_DECL uint glm::sqrt </td>
  274. <td>(</td>
  275. <td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&#160;</td>
  276. <td class="paramname"><em>x</em></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Returns the positive square root of x. </p>
  282. <p>From GLM_GTX_integer extension. </p>
  283. </div>
  284. </div>
  285. </div><!-- contents -->
  286. <!-- start footer part -->
  287. <hr class="footer"/><address class="footer"><small>
  288. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  289. <img class="footer" src="doxygen.png" alt="doxygen"/>
  290. </a> 1.8.10
  291. </small></address>
  292. </body>
  293. </html>