2
0

a00948.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.2 API documentation: GLM_GTX_integer</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">1.0.2 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  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="#typedef-members">Typedefs</a> &#124;
  65. <a href="#func-members">Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">GLM_GTX_integer<div class="ingroups"><a class="el" href="a00905.html">Experimental extensions</a></div></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  72. Typedefs</h2></td></tr>
  73. <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="a00948.html#gada7e83fdfe943aba4f1d5bf80cb66f40">sint</a></td></tr>
  74. <tr class="memdesc:gada7e83fdfe943aba4f1d5bf80cb66f40"><td class="mdescLeft">&#160;</td><td class="mdescRight">32bit signed integer. <a href="a00948.html#gada7e83fdfe943aba4f1d5bf80cb66f40">More...</a><br /></td></tr>
  75. <tr class="separator:gada7e83fdfe943aba4f1d5bf80cb66f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:ga8cbd3120905f398ec321b5d1836e08fb"><td class="memTemplParams" colspan="2"><a id="ga8cbd3120905f398ec321b5d1836e08fb"></a>
  80. template&lt;typename genType &gt; </td></tr>
  81. <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="a00948.html#ga8cbd3120905f398ec321b5d1836e08fb">factorial</a> (genType const &amp;x)</td></tr>
  82. <tr class="memdesc:ga8cbd3120905f398ec321b5d1836e08fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension. <br /></td></tr>
  83. <tr class="separator:ga8cbd3120905f398ec321b5d1836e08fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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="a00948.html#ga7011b4e1c1e1ed492149b028feacc00e">floor_log2</a> (unsigned int x)</td></tr>
  85. <tr class="memdesc:ga7011b4e1c1e1ed492149b028feacc00e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the floor log2 of x. <a href="a00948.html#ga7011b4e1c1e1ed492149b028feacc00e">More...</a><br /></td></tr>
  86. <tr class="separator:ga7011b4e1c1e1ed492149b028feacc00e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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="a00948.html#gaabfbb41531ab7ad8d06fc176edfba785">mod</a> (int x, int y)</td></tr>
  88. <tr class="memdesc:gaabfbb41531ab7ad8d06fc176edfba785"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00948.html#gaabfbb41531ab7ad8d06fc176edfba785">More...</a><br /></td></tr>
  89. <tr class="separator:gaabfbb41531ab7ad8d06fc176edfba785"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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="a00948.html#ga63fc8d63e7da1706439233b386ba8b6f">mod</a> (uint x, uint y)</td></tr>
  91. <tr class="memdesc:ga63fc8d63e7da1706439233b386ba8b6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00948.html#ga63fc8d63e7da1706439233b386ba8b6f">More...</a><br /></td></tr>
  92. <tr class="separator:ga63fc8d63e7da1706439233b386ba8b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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="a00948.html#ga78dff8bdb361bf0061194c93e003d189">nlz</a> (uint x)</td></tr>
  94. <tr class="memdesc:ga78dff8bdb361bf0061194c93e003d189"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of leading zeros. <a href="a00948.html#ga78dff8bdb361bf0061194c93e003d189">More...</a><br /></td></tr>
  95. <tr class="separator:ga78dff8bdb361bf0061194c93e003d189"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga465016030a81d513fa2fac881ebdaa83"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00948.html#ga465016030a81d513fa2fac881ebdaa83">pow</a> (int x, uint y)</td></tr>
  97. <tr class="memdesc:ga465016030a81d513fa2fac881ebdaa83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the y power. <a href="a00948.html#ga465016030a81d513fa2fac881ebdaa83">More...</a><br /></td></tr>
  98. <tr class="separator:ga465016030a81d513fa2fac881ebdaa83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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="a00948.html#ga998e5ee915d3769255519e2fbaa2bbf0">pow</a> (uint x, uint y)</td></tr>
  100. <tr class="memdesc:ga998e5ee915d3769255519e2fbaa2bbf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the y power. <a href="a00948.html#ga998e5ee915d3769255519e2fbaa2bbf0">More...</a><br /></td></tr>
  101. <tr class="separator:ga998e5ee915d3769255519e2fbaa2bbf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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="a00948.html#ga7ce36693a75879ccd9bb10167cfa722d">sqrt</a> (int x)</td></tr>
  103. <tr class="memdesc:ga7ce36693a75879ccd9bb10167cfa722d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the positive square root of x. <a href="a00948.html#ga7ce36693a75879ccd9bb10167cfa722d">More...</a><br /></td></tr>
  104. <tr class="separator:ga7ce36693a75879ccd9bb10167cfa722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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="a00948.html#ga1975d318978d6dacf78b6444fa5ed7bc">sqrt</a> (uint x)</td></tr>
  106. <tr class="memdesc:ga1975d318978d6dacf78b6444fa5ed7bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the positive square root of x. <a href="a00948.html#ga1975d318978d6dacf78b6444fa5ed7bc">More...</a><br /></td></tr>
  107. <tr class="separator:ga1975d318978d6dacf78b6444fa5ed7bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table>
  109. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  110. <p>Include &lt;<a class="el" href="a01693.html" title="GLM_GTX_integer">glm/gtx/integer.hpp</a>&gt; to use the features of this extension.</p>
  111. <p>Add support for integer for core functions </p>
  112. <h2 class="groupheader">Typedef Documentation</h2>
  113. <a id="gada7e83fdfe943aba4f1d5bf80cb66f40"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#gada7e83fdfe943aba4f1d5bf80cb66f40">&#9670;&nbsp;</a></span>sint</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">typedef signed int <a class="el" href="a00948.html#gada7e83fdfe943aba4f1d5bf80cb66f40">sint</a></td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>32bit signed integer. </p>
  124. <p>From GLM_GTX_integer extension. </p>
  125. <p class="definition">Definition at line <a class="el" href="a01693_source.html#l00053">53</a> of file <a class="el" href="a01693_source.html">gtx/integer.hpp</a>.</p>
  126. </div>
  127. </div>
  128. <h2 class="groupheader">Function Documentation</h2>
  129. <a id="ga7011b4e1c1e1ed492149b028feacc00e"></a>
  130. <h2 class="memtitle"><span class="permalink"><a href="#ga7011b4e1c1e1ed492149b028feacc00e">&#9670;&nbsp;</a></span>floor_log2()</h2>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">GLM_FUNC_DECL unsigned int glm::floor_log2 </td>
  136. <td>(</td>
  137. <td class="paramtype">unsigned int&#160;</td>
  138. <td class="paramname"><em>x</em></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Returns the floor log2 of x. </p>
  144. <p>From GLM_GTX_integer extension. </p>
  145. </div>
  146. </div>
  147. <a id="gaabfbb41531ab7ad8d06fc176edfba785"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#gaabfbb41531ab7ad8d06fc176edfba785">&#9670;&nbsp;</a></span>mod() <span class="overload">[1/2]</span></h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">GLM_FUNC_DECL int glm::mod </td>
  154. <td>(</td>
  155. <td class="paramtype">int&#160;</td>
  156. <td class="paramname"><em>x</em>, </td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey"></td>
  160. <td></td>
  161. <td class="paramtype">int&#160;</td>
  162. <td class="paramname"><em>y</em>&#160;</td>
  163. </tr>
  164. <tr>
  165. <td></td>
  166. <td>)</td>
  167. <td></td><td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Modulus. </p>
  172. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
  173. </div>
  174. </div>
  175. <a id="ga63fc8d63e7da1706439233b386ba8b6f"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#ga63fc8d63e7da1706439233b386ba8b6f">&#9670;&nbsp;</a></span>mod() <span class="overload">[2/2]</span></h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">GLM_FUNC_DECL uint glm::mod </td>
  182. <td>(</td>
  183. <td class="paramtype">uint&#160;</td>
  184. <td class="paramname"><em>x</em>, </td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey"></td>
  188. <td></td>
  189. <td class="paramtype">uint&#160;</td>
  190. <td class="paramname"><em>y</em>&#160;</td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td>)</td>
  195. <td></td><td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Modulus. </p>
  200. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
  201. </div>
  202. </div>
  203. <a id="ga78dff8bdb361bf0061194c93e003d189"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#ga78dff8bdb361bf0061194c93e003d189">&#9670;&nbsp;</a></span>nlz()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">GLM_FUNC_DECL uint glm::nlz </td>
  210. <td>(</td>
  211. <td class="paramtype">uint&#160;</td>
  212. <td class="paramname"><em>x</em></td><td>)</td>
  213. <td></td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Returns the number of leading zeros. </p>
  218. <p>From GLM_GTX_integer extension. </p>
  219. </div>
  220. </div>
  221. <a id="ga465016030a81d513fa2fac881ebdaa83"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#ga465016030a81d513fa2fac881ebdaa83">&#9670;&nbsp;</a></span>pow() <span class="overload">[1/2]</span></h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">GLM_FUNC_DECL int glm::pow </td>
  228. <td>(</td>
  229. <td class="paramtype">int&#160;</td>
  230. <td class="paramname"><em>x</em>, </td>
  231. </tr>
  232. <tr>
  233. <td class="paramkey"></td>
  234. <td></td>
  235. <td class="paramtype">uint&#160;</td>
  236. <td class="paramname"><em>y</em>&#160;</td>
  237. </tr>
  238. <tr>
  239. <td></td>
  240. <td>)</td>
  241. <td></td><td></td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Returns x raised to the y power. </p>
  246. <p>From GLM_GTX_integer extension. </p>
  247. </div>
  248. </div>
  249. <a id="ga998e5ee915d3769255519e2fbaa2bbf0"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#ga998e5ee915d3769255519e2fbaa2bbf0">&#9670;&nbsp;</a></span>pow() <span class="overload">[2/2]</span></h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">GLM_FUNC_DECL uint glm::pow </td>
  256. <td>(</td>
  257. <td class="paramtype">uint&#160;</td>
  258. <td class="paramname"><em>x</em>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">uint&#160;</td>
  264. <td class="paramname"><em>y</em>&#160;</td>
  265. </tr>
  266. <tr>
  267. <td></td>
  268. <td>)</td>
  269. <td></td><td></td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Returns x raised to the y power. </p>
  274. <p>From GLM_GTX_integer extension. </p>
  275. </div>
  276. </div>
  277. <a id="ga7ce36693a75879ccd9bb10167cfa722d"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#ga7ce36693a75879ccd9bb10167cfa722d">&#9670;&nbsp;</a></span>sqrt() <span class="overload">[1/2]</span></h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">GLM_FUNC_DECL int glm::sqrt </td>
  284. <td>(</td>
  285. <td class="paramtype">int&#160;</td>
  286. <td class="paramname"><em>x</em></td><td>)</td>
  287. <td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Returns the positive square root of x. </p>
  292. <p>From GLM_GTX_integer extension. </p>
  293. </div>
  294. </div>
  295. <a id="ga1975d318978d6dacf78b6444fa5ed7bc"></a>
  296. <h2 class="memtitle"><span class="permalink"><a href="#ga1975d318978d6dacf78b6444fa5ed7bc">&#9670;&nbsp;</a></span>sqrt() <span class="overload">[2/2]</span></h2>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">GLM_FUNC_DECL uint glm::sqrt </td>
  302. <td>(</td>
  303. <td class="paramtype">uint&#160;</td>
  304. <td class="paramname"><em>x</em></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Returns the positive square root of x. </p>
  310. <p>From GLM_GTX_integer extension. </p>
  311. </div>
  312. </div>
  313. </div><!-- contents -->
  314. <!-- start footer part -->
  315. <hr class="footer"/><address class="footer"><small>
  316. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  317. <img class="footer" src="doxygen.png" alt="doxygen"/>
  318. </a> 1.8.18
  319. </small></address>
  320. </body>
  321. </html>