a00165.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  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.9 API documenation: GLM_GTC_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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documenation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">GLM_GTC_integer<div class="ingroups"><a class="el" href="a00153.html">GTC Extensions (Stable)</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Allow to perform bit operations on integer values.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <tr class="memitem:ga0a42ffb863cc980e91f98d2f5766de20"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  88. <tr class="memitem:ga0a42ffb863cc980e91f98d2f5766de20"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; int, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga0a42ffb863cc980e91f98d2f5766de20">iround</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  89. <tr class="memdesc:ga0a42ffb863cc980e91f98d2f5766de20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00165.html#ga0a42ffb863cc980e91f98d2f5766de20">More...</a><br /></td></tr>
  90. <tr class="separator:ga0a42ffb863cc980e91f98d2f5766de20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  92. <tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga9bd682e74bfacb005c735305207ec417">log2</a> (genIUType x)</td></tr>
  93. <tr class="memdesc:ga9bd682e74bfacb005c735305207ec417"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the log2 of x for integer values. <a href="a00165.html#ga9bd682e74bfacb005c735305207ec417">More...</a><br /></td></tr>
  94. <tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  96. <tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a> (genIUType x, genIUType y)</td></tr>
  97. <tr class="memdesc:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00165.html#ga75c6fd2a143fc44e5f7b871abad539e0">More...</a><br /></td></tr>
  98. <tr class="separator:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  100. <tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">mod</a> (vecType&lt; T, P &gt; const &amp;x, T y)</td></tr>
  101. <tr class="memdesc:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00165.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">More...</a><br /></td></tr>
  102. <tr class="separator:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  104. <tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">mod</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
  105. <tr class="memdesc:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00165.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">More...</a><br /></td></tr>
  106. <tr class="separator:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:gab61b8546aafdf58f119eb892b212607c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  108. <tr class="memitem:gab61b8546aafdf58f119eb892b212607c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; uint, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gab61b8546aafdf58f119eb892b212607c">uround</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  109. <tr class="memdesc:gab61b8546aafdf58f119eb892b212607c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00165.html#gab61b8546aafdf58f119eb892b212607c">More...</a><br /></td></tr>
  110. <tr class="separator:gab61b8546aafdf58f119eb892b212607c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  113. <p>Allow to perform bit operations on integer values. </p>
  114. <p>&lt;<a class="el" href="a00045.html" title="GLM_GTC_integer ">glm/gtc/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
  115. <h2 class="groupheader">Function Documentation</h2>
  116. <a class="anchor" id="ga0a42ffb863cc980e91f98d2f5766de20"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">GLM_FUNC_DECL vecType&lt;int, P&gt; glm::iround </td>
  122. <td>(</td>
  123. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  124. <td class="paramname"><em>x</em></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Returns a value equal to the nearest integer to x. </p>
  130. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
  131. <dl class="params"><dt>Parameters</dt><dd>
  132. <table class="params">
  133. <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
  134. </table>
  135. </dd>
  136. </dl>
  137. <dl class="tparams"><dt>Template Parameters</dt><dd>
  138. <table class="tparams">
  139. <tr><td class="paramname">T</td><td>floating point scalar types. </td></tr>
  140. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/round.xml">GLSL round man page</a> </dd>
  145. <dd>
  146. <a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
  147. </div>
  148. </div>
  149. <a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td>
  155. <td>(</td>
  156. <td class="paramtype">genIUType&#160;</td>
  157. <td class="paramname"><em>x</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Returns the log2 of x for integer values. </p>
  163. <p>Can be reliably using to compute mipmap count from the texture size. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
  164. </div>
  165. </div>
  166. <a class="anchor" id="ga75c6fd2a143fc44e5f7b871abad539e0"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">GLM_FUNC_DECL genIUType glm::mod </td>
  172. <td>(</td>
  173. <td class="paramtype">genIUType&#160;</td>
  174. <td class="paramname"><em>x</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">genIUType&#160;</td>
  180. <td class="paramname"><em>y</em>&#160;</td>
  181. </tr>
  182. <tr>
  183. <td></td>
  184. <td>)</td>
  185. <td></td><td></td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Modulus. </p>
  190. <p>Returns x % y for each component in x using the floating point value y.</p>
  191. <dl class="tparams"><dt>Template Parameters</dt><dd>
  192. <table class="tparams">
  193. <tr><td class="paramname">genIUType</td><td>Integer-point scalar or vector types.</td></tr>
  194. </table>
  195. </dd>
  196. </dl>
  197. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  198. <dd>
  199. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  200. <dd>
  201. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
  202. </div>
  203. </div>
  204. <a class="anchor" id="gac76ae7d82ff22526bcf6d6a1b51af6c3"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
  210. <td>(</td>
  211. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  212. <td class="paramname"><em>x</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">T&#160;</td>
  218. <td class="paramname"><em>y</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Modulus. </p>
  228. <p>Returns x % y for each component in x using the floating point value y.</p>
  229. <dl class="tparams"><dt>Template Parameters</dt><dd>
  230. <table class="tparams">
  231. <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
  232. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  233. </table>
  234. </dd>
  235. </dl>
  236. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  237. <dd>
  238. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  239. <dd>
  240. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
  241. </div>
  242. </div>
  243. <a class="anchor" id="gaf5ae5330f6b30b4a35fb95f9a73d6134"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
  249. <td>(</td>
  250. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  251. <td class="paramname"><em>x</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  257. <td class="paramname"><em>y</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Modulus. </p>
  267. <p>Returns x % y for each component in x using the floating point value y.</p>
  268. <dl class="tparams"><dt>Template Parameters</dt><dd>
  269. <table class="tparams">
  270. <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
  271. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  272. </table>
  273. </dd>
  274. </dl>
  275. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  276. <dd>
  277. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  278. <dd>
  279. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
  280. </div>
  281. </div>
  282. <a class="anchor" id="gab61b8546aafdf58f119eb892b212607c"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">GLM_FUNC_DECL vecType&lt;uint, P&gt; glm::uround </td>
  288. <td>(</td>
  289. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  290. <td class="paramname"><em>x</em></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Returns a value equal to the nearest integer to x. </p>
  296. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. <dl class="tparams"><dt>Template Parameters</dt><dd>
  304. <table class="tparams">
  305. <tr><td class="paramname">T</td><td>floating point scalar types. </td></tr>
  306. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  307. </table>
  308. </dd>
  309. </dl>
  310. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/round.xml">GLSL round man page</a> </dd>
  311. <dd>
  312. <a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
  313. </div>
  314. </div>
  315. </div><!-- contents -->
  316. <!-- start footer part -->
  317. <hr class="footer"/><address class="footer"><small>
  318. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  319. <img class="footer" src="doxygen.png" alt="doxygen"/>
  320. </a> 1.8.10
  321. </small></address>
  322. </body>
  323. </html>