Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.5
Branches Tags
glm
/
doc
/
api
/
a00202.html

a00202.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.5"/>
    7. 

  7. <title>GLM: GLM_GTX_integer</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    15. 

  15. <div id="titlearea">
    16. 

  16. <table cellspacing="0" cellpadding="0">
    17. 

  17.  <tbody>
    18. 

  18.  <tr style="height: 56px;">
    19. 

  19.   <td style="padding-left: 0.5em;">
    20. 

  20.    <div id="projectname">GLM
    21. 

  21.    &#160;<span id="projectnumber">0.9.5</span>
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.5 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    36. 

  36.       <li><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39. </div><!-- top -->
    40. 

  40. <div class="header">
    41. 

  41.   <div class="summary">
    42. 

  42. <a href="#typedef-members">Typedefs</a> &#124;
    43. 

  43. <a href="#func-members">Functions</a>  </div>
    44. 

  44.   <div class="headertitle">
    45. 

  45. <div class="title">GLM_GTX_integer<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div>  </div>
    46. 

  46. </div><!--header-->
    47. 

  47. <div class="contents">
    48. 

  48. <table class="memberdecls">
    49. 

  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
    50. 

  50. Typedefs</h2></td></tr>
    51. 

  51. <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="a00202.html#gada7e83fdfe943aba4f1d5bf80cb66f40">sint</a></td></tr>
    52. 

  52. <tr class="separator:gada7e83fdfe943aba4f1d5bf80cb66f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. </table><table class="memberdecls">
    54. 

  54. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    55. 

  55. Functions</h2></td></tr>
    56. 

  56. <tr class="memitem:ga6912d62d2f314fa38ef4c94fda778294"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    57. 

  57. <tr class="memitem:ga6912d62d2f314fa38ef4c94fda778294"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00202.html#ga6912d62d2f314fa38ef4c94fda778294">factorial</a> (genType const &amp;x)</td></tr>
    58. 

  58. <tr class="separator:ga6912d62d2f314fa38ef4c94fda778294"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:ga054b9fd24e0d18af9ae7e9b6bfb5a2c9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#ga054b9fd24e0d18af9ae7e9b6bfb5a2c9">floor_log2</a> (unsigned int x)</td></tr>
    60. 

  60. <tr class="separator:ga054b9fd24e0d18af9ae7e9b6bfb5a2c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    61. 

  61. <tr class="memitem:gae6836e4b1445f55ab30f32e3da36c284"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
    62. 

  62. <tr class="memitem:gae6836e4b1445f55ab30f32e3da36c284"><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00202.html#gae6836e4b1445f55ab30f32e3da36c284">log2</a> (genIUType const &amp;x)</td></tr>
    63. 

  63. <tr class="separator:gae6836e4b1445f55ab30f32e3da36c284"><td class="memSeparator" colspan="2">&#160;</td></tr>
    64. 

  64. <tr class="memitem:ga01082d953f4864e9accbcb84987a1066"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#ga01082d953f4864e9accbcb84987a1066">mod</a> (int x, int y)</td></tr>
    65. 

  65. <tr class="separator:ga01082d953f4864e9accbcb84987a1066"><td class="memSeparator" colspan="2">&#160;</td></tr>
    66. 

  66. <tr class="memitem:ga5f05facb4b70489113d284edd53babcb"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#ga5f05facb4b70489113d284edd53babcb">mod</a> (uint x, uint y)</td></tr>
    67. 

  67. <tr class="separator:ga5f05facb4b70489113d284edd53babcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. <tr class="memitem:gade78ad3e82d61001f4641571db4dd56e"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#gade78ad3e82d61001f4641571db4dd56e">nlz</a> (uint x)</td></tr>
    69. 

  69. <tr class="separator:gade78ad3e82d61001f4641571db4dd56e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    70. 

  70. <tr class="memitem:ga0073d991d1c9c9a37b458eb512535fc8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#ga0073d991d1c9c9a37b458eb512535fc8">pow</a> (int x, int y)</td></tr>
    71. 

  71. <tr class="separator:ga0073d991d1c9c9a37b458eb512535fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    72. 

  72. <tr class="memitem:gaaff5d34714236dbeddd49e4ecb045abc"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#gaaff5d34714236dbeddd49e4ecb045abc">pow</a> (uint x, uint y)</td></tr>
    73. 

  73. <tr class="separator:gaaff5d34714236dbeddd49e4ecb045abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga6aad88cb883810890ac2b68000c544c1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#ga6aad88cb883810890ac2b68000c544c1">sqrt</a> (int x)</td></tr>
    75. 

  75. <tr class="separator:ga6aad88cb883810890ac2b68000c544c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:gafb4f8acb2b577775e2ef1a86e7312340"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00202.html#gafb4f8acb2b577775e2ef1a86e7312340">sqrt</a> (uint x)</td></tr>
    77. 

  77. <tr class="separator:gafb4f8acb2b577775e2ef1a86e7312340"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. </table>
    79. 

  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    80. 

  80. <p>Add support for integer for core functions. </p>
    81. 

  81. <p>&lt;<a class="el" href="a00049.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
    82. 

  82. <h2 class="groupheader">Typedef Documentation</h2>
    83. 

  83. <a class="anchor" id="gada7e83fdfe943aba4f1d5bf80cb66f40"></a>
    84. 

  84. <div class="memitem">
    85. 

  85. <div class="memproto">
    86. 

  86.       <table class="memname">
    87. 

  87.         <tr>
    88. 

  88.           <td class="memname">typedef signed int sint</td>
    89. 

  89.         </tr>
    90. 

  90.       </table>
    91. 

  91. </div><div class="memdoc">
    92. 

  92. 

  93. <p>32bit signed integer. </p>
    94. 

  94. <p>From GLM_GTX_integer extension. </p>
    95. 

  95. 

  96. <p>Definition at line <a class="el" href="a00049_source.html#l00081">81</a> of file <a class="el" href="a00049_source.html">gtx/integer.hpp</a>.</p>
    97. 

  97. 

  98. </div>
    99. 

  99. </div>
    100. 

  100. <h2 class="groupheader">Function Documentation</h2>
    101. 

  101. <a class="anchor" id="ga6912d62d2f314fa38ef4c94fda778294"></a>
    102. 

  102. <div class="memitem">
    103. 

  103. <div class="memproto">
    104. 

  104.       <table class="memname">
    105. 

  105.         <tr>
    106. 

  106.           <td class="memname">genType glm::factorial </td>
    107. 

  107.           <td>(</td>
    108. 

  108.           <td class="paramtype">genType const &amp;&#160;</td>
    109. 

  109.           <td class="paramname"><em>x</em></td><td>)</td>
    110. 

  110.           <td></td>
    111. 

  111.         </tr>
    112. 

  112.       </table>
    113. 

  113. </div><div class="memdoc">
    114. 

  114. 

  115. <p>Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension. </p>
    116. 

  116. 

  117. </div>
    118. 

  118. </div>
    119. 

  119. <a class="anchor" id="ga054b9fd24e0d18af9ae7e9b6bfb5a2c9"></a>
    120. 

  120. <div class="memitem">
    121. 

  121. <div class="memproto">
    122. 

  122.       <table class="memname">
    123. 

  123.         <tr>
    124. 

  124.           <td class="memname">unsigned int glm::floor_log2 </td>
    125. 

  125.           <td>(</td>
    126. 

  126.           <td class="paramtype">unsigned int&#160;</td>
    127. 

  127.           <td class="paramname"><em>x</em></td><td>)</td>
    128. 

  128.           <td></td>
    129. 

  129.         </tr>
    130. 

  130.       </table>
    131. 

  131. </div><div class="memdoc">
    132. 

  132. 

  133. <p>Returns the floor log2 of x. </p>
    134. 

  134. <p>From GLM_GTX_integer extension. </p>
    135. 

  135. 

  136. </div>
    137. 

  137. </div>
    138. 

  138. <a class="anchor" id="gae6836e4b1445f55ab30f32e3da36c284"></a>
    139. 

  139. <div class="memitem">
    140. 

  140. <div class="memproto">
    141. 

  141.       <table class="memname">
    142. 

  142.         <tr>
    143. 

  143.           <td class="memname">genIUType glm::log2 </td>
    144. 

  144.           <td>(</td>
    145. 

  145.           <td class="paramtype">genIUType const &amp;&#160;</td>
    146. 

  146.           <td class="paramname"><em>x</em></td><td>)</td>
    147. 

  147.           <td></td>
    148. 

  148.         </tr>
    149. 

  149.       </table>
    150. 

  150. </div><div class="memdoc">
    151. 

  151. 

  152. <p>Returns the log2 of x. </p>
    153. 

  153. <p>Can be reliably using to compute mipmap count from the texture size. From GLM_GTX_integer extension. </p>
    154. 

  154. 

  155. </div>
    156. 

  156. </div>
    157. 

  157. <a class="anchor" id="ga01082d953f4864e9accbcb84987a1066"></a>
    158. 

  158. <div class="memitem">
    159. 

  159. <div class="memproto">
    160. 

  160.       <table class="memname">
    161. 

  161.         <tr>
    162. 

  162.           <td class="memname">int glm::mod </td>
    163. 

  163.           <td>(</td>
    164. 

  164.           <td class="paramtype">int&#160;</td>
    165. 

  165.           <td class="paramname"><em>x</em>, </td>
    166. 

  166.         </tr>
    167. 

  167.         <tr>
    168. 

  168.           <td class="paramkey"></td>
    169. 

  169.           <td></td>
    170. 

  170.           <td class="paramtype">int&#160;</td>
    171. 

  171.           <td class="paramname"><em>y</em>&#160;</td>
    172. 

  172.         </tr>
    173. 

  173.         <tr>
    174. 

  174.           <td></td>
    175. 

  175.           <td>)</td>
    176. 

  176.           <td></td><td></td>
    177. 

  177.         </tr>
    178. 

  178.       </table>
    179. 

  179. </div><div class="memdoc">
    180. 

  180. 

  181. <p>Modulus. </p>
    182. 

  182. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
    183. 

  183. 

  184. </div>
    185. 

  185. </div>
    186. 

  186. <a class="anchor" id="ga5f05facb4b70489113d284edd53babcb"></a>
    187. 

  187. <div class="memitem">
    188. 

  188. <div class="memproto">
    189. 

  189.       <table class="memname">
    190. 

  190.         <tr>
    191. 

  191.           <td class="memname">uint glm::mod </td>
    192. 

  192.           <td>(</td>
    193. 

  193.           <td class="paramtype">uint&#160;</td>
    194. 

  194.           <td class="paramname"><em>x</em>, </td>
    195. 

  195.         </tr>
    196. 

  196.         <tr>
    197. 

  197.           <td class="paramkey"></td>
    198. 

  198.           <td></td>
    199. 

  199.           <td class="paramtype">uint&#160;</td>
    200. 

  200.           <td class="paramname"><em>y</em>&#160;</td>
    201. 

  201.         </tr>
    202. 

  202.         <tr>
    203. 

  203.           <td></td>
    204. 

  204.           <td>)</td>
    205. 

  205.           <td></td><td></td>
    206. 

  206.         </tr>
    207. 

  207.       </table>
    208. 

  208. </div><div class="memdoc">
    209. 

  209. 

  210. <p>Modulus. </p>
    211. 

  211. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
    212. 

  212. 

  213. </div>
    214. 

  214. </div>
    215. 

  215. <a class="anchor" id="gade78ad3e82d61001f4641571db4dd56e"></a>
    216. 

  216. <div class="memitem">
    217. 

  217. <div class="memproto">
    218. 

  218.       <table class="memname">
    219. 

  219.         <tr>
    220. 

  220.           <td class="memname">uint glm::nlz </td>
    221. 

  221.           <td>(</td>
    222. 

  222.           <td class="paramtype">uint&#160;</td>
    223. 

  223.           <td class="paramname"><em>x</em></td><td>)</td>
    224. 

  224.           <td></td>
    225. 

  225.         </tr>
    226. 

  226.       </table>
    227. 

  227. </div><div class="memdoc">
    228. 

  228. 

  229. <p>Returns the number of leading zeros. </p>
    230. 

  230. <p>From GLM_GTX_integer extension. </p>
    231. 

  231. 

  232. </div>
    233. 

  233. </div>
    234. 

  234. <a class="anchor" id="ga0073d991d1c9c9a37b458eb512535fc8"></a>
    235. 

  235. <div class="memitem">
    236. 

  236. <div class="memproto">
    237. 

  237.       <table class="memname">
    238. 

  238.         <tr>
    239. 

  239.           <td class="memname">int glm::pow </td>
    240. 

  240.           <td>(</td>
    241. 

  241.           <td class="paramtype">int&#160;</td>
    242. 

  242.           <td class="paramname"><em>x</em>, </td>
    243. 

  243.         </tr>
    244. 

  244.         <tr>
    245. 

  245.           <td class="paramkey"></td>
    246. 

  246.           <td></td>
    247. 

  247.           <td class="paramtype">int&#160;</td>
    248. 

  248.           <td class="paramname"><em>y</em>&#160;</td>
    249. 

  249.         </tr>
    250. 

  250.         <tr>
    251. 

  251.           <td></td>
    252. 

  252.           <td>)</td>
    253. 

  253.           <td></td><td></td>
    254. 

  254.         </tr>
    255. 

  255.       </table>
    256. 

  256. </div><div class="memdoc">
    257. 

  257. 

  258. <p>Returns x raised to the y power. </p>
    259. 

  259. <p>From GLM_GTX_integer extension. </p>
    260. 

  260. 

  261. </div>
    262. 

  262. </div>
    263. 

  263. <a class="anchor" id="gaaff5d34714236dbeddd49e4ecb045abc"></a>
    264. 

  264. <div class="memitem">
    265. 

  265. <div class="memproto">
    266. 

  266.       <table class="memname">
    267. 

  267.         <tr>
    268. 

  268.           <td class="memname">uint glm::pow </td>
    269. 

  269.           <td>(</td>
    270. 

  270.           <td class="paramtype">uint&#160;</td>
    271. 

  271.           <td class="paramname"><em>x</em>, </td>
    272. 

  272.         </tr>
    273. 

  273.         <tr>
    274. 

  274.           <td class="paramkey"></td>
    275. 

  275.           <td></td>
    276. 

  276.           <td class="paramtype">uint&#160;</td>
    277. 

  277.           <td class="paramname"><em>y</em>&#160;</td>
    278. 

  278.         </tr>
    279. 

  279.         <tr>
    280. 

  280.           <td></td>
    281. 

  281.           <td>)</td>
    282. 

  282.           <td></td><td></td>
    283. 

  283.         </tr>
    284. 

  284.       </table>
    285. 

  285. </div><div class="memdoc">
    286. 

  286. 

  287. <p>Returns x raised to the y power. </p>
    288. 

  288. <p>From GLM_GTX_integer extension. </p>
    289. 

  289. 

  290. </div>
    291. 

  291. </div>
    292. 

  292. <a class="anchor" id="ga6aad88cb883810890ac2b68000c544c1"></a>
    293. 

  293. <div class="memitem">
    294. 

  294. <div class="memproto">
    295. 

  295.       <table class="memname">
    296. 

  296.         <tr>
    297. 

  297.           <td class="memname">int glm::sqrt </td>
    298. 

  298.           <td>(</td>
    299. 

  299.           <td class="paramtype">int&#160;</td>
    300. 

  300.           <td class="paramname"><em>x</em></td><td>)</td>
    301. 

  301.           <td></td>
    302. 

  302.         </tr>
    303. 

  303.       </table>
    304. 

  304. </div><div class="memdoc">
    305. 

  305. 

  306. <p>Returns the positive square root of x. </p>
    307. 

  307. <p>From GLM_GTX_integer extension. </p>
    308. 

  308. 

  309. </div>
    310. 

  310. </div>
    311. 

  311. <a class="anchor" id="gafb4f8acb2b577775e2ef1a86e7312340"></a>
    312. 

  312. <div class="memitem">
    313. 

  313. <div class="memproto">
    314. 

  314.       <table class="memname">
    315. 

  315.         <tr>
    316. 

  316.           <td class="memname">uint glm::sqrt </td>
    317. 

  317.           <td>(</td>
    318. 

  318.           <td class="paramtype">uint&#160;</td>
    319. 

  319.           <td class="paramname"><em>x</em></td><td>)</td>
    320. 

  320.           <td></td>
    321. 

  321.         </tr>
    322. 

  322.       </table>
    323. 

  323. </div><div class="memdoc">
    324. 

  324. 

  325. <p>Returns the positive square root of x. </p>
    326. 

  326. <p>From GLM_GTX_integer extension. </p>
    327. 

  327. 

  328. </div>
    329. 

  329. </div>
    330. 

  330. </div><!-- contents -->
    331. 

  331. <!-- start footer part -->
    332. 

  332. <hr class="footer"/><address class="footer"><small>
    333. 

  333. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    334. 

  334. <img class="footer" src="doxygen.png" alt="doxygen"/>
    335. 

  335. </a> 1.8.5
    336. 

  336. </small></address>
    337. 

  337. </body>
    338. 

  338. </html>
    339.