a00178.html 14 KB

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