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

a00165.html 15 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299 
  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.10"/>
    7. 

  7. <title>0.9.8 API documenation: GLM_GTC_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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    20. 

  20.   <td id="projectalign" style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">0.9.8 API documenation
    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.10 -->
    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="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="files.html"><span>Files</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37. </div><!-- top -->
    38. 

  38. <div class="header">
    39. 

  39.   <div class="summary">
    40. 

  40. <a href="#func-members">Functions</a>  </div>
    41. 

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

  42. <div class="title">GLM_GTC_integer<div class="ingroups"><a class="el" href="a00153.html">GTC Extensions (Stable)</a></div></div>  </div>
    43. 

  43. </div><!--header-->
    44. 

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

  45. 

  46. <p>Allow to perform bit operations on integer values.  
    47. 

  47. <a href="#details">More...</a></p>
    48. 

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

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

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

  51. <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>
    52. 

  52. <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>
    53. 

  53. <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>
    54. 

  54. <tr class="separator:ga0a42ffb863cc980e91f98d2f5766de20"><td class="memSeparator" colspan="2">&#160;</td></tr>
    55. 

  55. <tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
    56. 

  56. <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>
    57. 

  57. <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>
    58. 

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

  59. <tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
    60. 

  60. <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>
    61. 

  61. <tr class="memdesc:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus.  <a href="a00165.html#ga75c6fd2a143fc44e5f7b871abad539e0">More...</a><br /></td></tr>
    62. 

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

  63. <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>
    64. 

  64. <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>
    65. 

  65. <tr class="memdesc:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus.  <a href="a00165.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">More...</a><br /></td></tr>
    66. 

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

  67. <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>
    68. 

  68. <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>
    69. 

  69. <tr class="memdesc:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus.  <a href="a00165.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">More...</a><br /></td></tr>
    70. 

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

  71. <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>
    72. 

  72. <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>
    73. 

  73. <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>
    74. 

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

  75. </table>
    76. 

  76. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    77. 

  77. <p>Allow to perform bit operations on integer values. </p>
    78. 

  78. <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>
    79. 

  79. <h2 class="groupheader">Function Documentation</h2>
    80. 

  80. <a class="anchor" id="ga0a42ffb863cc980e91f98d2f5766de20"></a>
    81. 

  81. <div class="memitem">
    82. 

  82. <div class="memproto">
    83. 

  83.       <table class="memname">
    84. 

  84.         <tr>
    85. 

  85.           <td class="memname">GLM_FUNC_DECL vecType&lt;int, P&gt; glm::iround </td>
    86. 

  86.           <td>(</td>
    87. 

  87.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    88. 

  88.           <td class="paramname"><em>x</em></td><td>)</td>
    89. 

  89.           <td></td>
    90. 

  90.         </tr>
    91. 

  91.       </table>
    92. 

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

  93. 

  94. <p>Returns a value equal to the nearest integer to x. </p>
    95. 

  95. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
    96. 

  96. <dl class="params"><dt>Parameters</dt><dd>
    97. 

  97.   <table class="params">
    98. 

  98.     <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
    99. 

  99.   </table>
    100. 

  100.   </dd>
    101. 

  101. </dl>
    102. 

  102. <dl class="tparams"><dt>Template Parameters</dt><dd>
    103. 

  103.   <table class="tparams">
    104. 

  104.     <tr><td class="paramname">T</td><td>floating point scalar types. </td></tr>
    105. 

  105.     <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
    106. 

  106.   </table>
    107. 

  107.   </dd>
    108. 

  108. </dl>
    109. 

  109. <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>
    110. 

  110. <dd>
    111. 

  111. <a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
    112. 

  112. 

  113. </div>
    114. 

  114. </div>
    115. 

  115. <a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a>
    116. 

  116. <div class="memitem">
    117. 

  117. <div class="memproto">
    118. 

  118.       <table class="memname">
    119. 

  119.         <tr>
    120. 

  120.           <td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td>
    121. 

  121.           <td>(</td>
    122. 

  122.           <td class="paramtype">genIUType&#160;</td>
    123. 

  123.           <td class="paramname"><em>x</em></td><td>)</td>
    124. 

  124.           <td></td>
    125. 

  125.         </tr>
    126. 

  126.       </table>
    127. 

  127. </div><div class="memdoc">
    128. 

  128. 

  129. <p>Returns the log2 of x for integer values. </p>
    130. 

  130. <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>
    131. 

  131. 

  132. </div>
    133. 

  133. </div>
    134. 

  134. <a class="anchor" id="ga75c6fd2a143fc44e5f7b871abad539e0"></a>
    135. 

  135. <div class="memitem">
    136. 

  136. <div class="memproto">
    137. 

  137.       <table class="memname">
    138. 

  138.         <tr>
    139. 

  139.           <td class="memname">GLM_FUNC_DECL genIUType glm::mod </td>
    140. 

  140.           <td>(</td>
    141. 

  141.           <td class="paramtype">genIUType&#160;</td>
    142. 

  142.           <td class="paramname"><em>x</em>, </td>
    143. 

  143.         </tr>
    144. 

  144.         <tr>
    145. 

  145.           <td class="paramkey"></td>
    146. 

  146.           <td></td>
    147. 

  147.           <td class="paramtype">genIUType&#160;</td>
    148. 

  148.           <td class="paramname"><em>y</em>&#160;</td>
    149. 

  149.         </tr>
    150. 

  150.         <tr>
    151. 

  151.           <td></td>
    152. 

  152.           <td>)</td>
    153. 

  153.           <td></td><td></td>
    154. 

  154.         </tr>
    155. 

  155.       </table>
    156. 

  156. </div><div class="memdoc">
    157. 

  157. 

  158. <p>Modulus. </p>
    159. 

  159. <p>Returns x % y for each component in x using the floating point value y.</p>
    160. 

  160. <dl class="tparams"><dt>Template Parameters</dt><dd>
    161. 

  161.   <table class="tparams">
    162. 

  162.     <tr><td class="paramname">genIUType</td><td>Integer-point scalar or vector types.</td></tr>
    163. 

  163.   </table>
    164. 

  164.   </dd>
    165. 

  165. </dl>
    166. 

  166. <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>
    167. 

  167. <dd>
    168. 

  168. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
    169. 

  169. <dd>
    170. 

  170. <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>
    171. 

  171. 

  172. </div>
    173. 

  173. </div>
    174. 

  174. <a class="anchor" id="gac76ae7d82ff22526bcf6d6a1b51af6c3"></a>
    175. 

  175. <div class="memitem">
    176. 

  176. <div class="memproto">
    177. 

  177.       <table class="memname">
    178. 

  178.         <tr>
    179. 

  179.           <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
    180. 

  180.           <td>(</td>
    181. 

  181.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    182. 

  182.           <td class="paramname"><em>x</em>, </td>
    183. 

  183.         </tr>
    184. 

  184.         <tr>
    185. 

  185.           <td class="paramkey"></td>
    186. 

  186.           <td></td>
    187. 

  187.           <td class="paramtype">T&#160;</td>
    188. 

  188.           <td class="paramname"><em>y</em>&#160;</td>
    189. 

  189.         </tr>
    190. 

  190.         <tr>
    191. 

  191.           <td></td>
    192. 

  192.           <td>)</td>
    193. 

  193.           <td></td><td></td>
    194. 

  194.         </tr>
    195. 

  195.       </table>
    196. 

  196. </div><div class="memdoc">
    197. 

  197. 

  198. <p>Modulus. </p>
    199. 

  199. <p>Returns x % y for each component in x using the floating point value y.</p>
    200. 

  200. <dl class="tparams"><dt>Template Parameters</dt><dd>
    201. 

  201.   <table class="tparams">
    202. 

  202.     <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
    203. 

  203.     <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
    204. 

  204.   </table>
    205. 

  205.   </dd>
    206. 

  206. </dl>
    207. 

  207. <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>
    208. 

  208. <dd>
    209. 

  209. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
    210. 

  210. <dd>
    211. 

  211. <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>
    212. 

  212. 

  213. </div>
    214. 

  214. </div>
    215. 

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

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

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

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

  219.         <tr>
    220. 

  220.           <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
    221. 

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

  222.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    223. 

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

  224.         </tr>
    225. 

  225.         <tr>
    226. 

  226.           <td class="paramkey"></td>
    227. 

  227.           <td></td>
    228. 

  228.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    229. 

  229.           <td class="paramname"><em>y</em>&#160;</td>
    230. 

  230.         </tr>
    231. 

  231.         <tr>
    232. 

  232.           <td></td>
    233. 

  233.           <td>)</td>
    234. 

  234.           <td></td><td></td>
    235. 

  235.         </tr>
    236. 

  236.       </table>
    237. 

  237. </div><div class="memdoc">
    238. 

  238. 

  239. <p>Modulus. </p>
    240. 

  240. <p>Returns x % y for each component in x using the floating point value y.</p>
    241. 

  241. <dl class="tparams"><dt>Template Parameters</dt><dd>
    242. 

  242.   <table class="tparams">
    243. 

  243.     <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
    244. 

  244.     <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
    245. 

  245.   </table>
    246. 

  246.   </dd>
    247. 

  247. </dl>
    248. 

  248. <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>
    249. 

  249. <dd>
    250. 

  250. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
    251. 

  251. <dd>
    252. 

  252. <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>
    253. 

  253. 

  254. </div>
    255. 

  255. </div>
    256. 

  256. <a class="anchor" id="gab61b8546aafdf58f119eb892b212607c"></a>
    257. 

  257. <div class="memitem">
    258. 

  258. <div class="memproto">
    259. 

  259.       <table class="memname">
    260. 

  260.         <tr>
    261. 

  261.           <td class="memname">GLM_FUNC_DECL vecType&lt;uint, P&gt; glm::uround </td>
    262. 

  262.           <td>(</td>
    263. 

  263.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    264. 

  264.           <td class="paramname"><em>x</em></td><td>)</td>
    265. 

  265.           <td></td>
    266. 

  266.         </tr>
    267. 

  267.       </table>
    268. 

  268. </div><div class="memdoc">
    269. 

  269. 

  270. <p>Returns a value equal to the nearest integer to x. </p>
    271. 

  271. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
    272. 

  272. <dl class="params"><dt>Parameters</dt><dd>
    273. 

  273.   <table class="params">
    274. 

  274.     <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
    275. 

  275.   </table>
    276. 

  276.   </dd>
    277. 

  277. </dl>
    278. 

  278. <dl class="tparams"><dt>Template Parameters</dt><dd>
    279. 

  279.   <table class="tparams">
    280. 

  280.     <tr><td class="paramname">T</td><td>floating point scalar types. </td></tr>
    281. 

  281.     <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
    282. 

  282.   </table>
    283. 

  283.   </dd>
    284. 

  284. </dl>
    285. 

  285. <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>
    286. 

  286. <dd>
    287. 

  287. <a class="el" href="a00165.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
    288. 

  288. 

  289. </div>
    290. 

  290. </div>
    291. 

  291. </div><!-- contents -->
    292. 

  292. <!-- start footer part -->
    293. 

  293. <hr class="footer"/><address class="footer"><small>
    294. 

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

  295. <img class="footer" src="doxygen.png" alt="doxygen"/>
    296. 

  296. </a> 1.8.10
    297. 

  297. </small></address>
    298. 

  298. </body>
    299. 

  299. </html>
    300.