a00167.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  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.8"/>
  7. <title>0.9.6: 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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.6
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">GLM_GTC_integer<div class="ingroups"><a class="el" href="a00158.html">GTC Extensions (Stable)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  49. <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="a00167.html#ga9bd682e74bfacb005c735305207ec417">log2</a> (genIUType x)</td></tr>
  50. <tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  52. <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="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a> (genIUType x, genIUType y)</td></tr>
  53. <tr class="separator:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <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>
  55. <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="a00167.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">mod</a> (vecType&lt; T, P &gt; const &amp;x, T y)</td></tr>
  56. <tr class="separator:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <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>
  58. <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="a00167.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">mod</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
  59. <tr class="separator:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. </table>
  61. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  62. <p>Allow to perform bit operations on integer values. </p>
  63. <p>&lt;<a class="el" href="a00042.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
  64. <h2 class="groupheader">Function Documentation</h2>
  65. <a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a>
  66. <div class="memitem">
  67. <div class="memproto">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td>
  71. <td>(</td>
  72. <td class="paramtype">genIUType&#160;</td>
  73. <td class="paramname"><em>x</em></td><td>)</td>
  74. <td></td>
  75. </tr>
  76. </table>
  77. </div><div class="memdoc">
  78. <p>Returns the log2 of x for integer values. </p>
  79. <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="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
  80. </div>
  81. </div>
  82. <a class="anchor" id="ga75c6fd2a143fc44e5f7b871abad539e0"></a>
  83. <div class="memitem">
  84. <div class="memproto">
  85. <table class="memname">
  86. <tr>
  87. <td class="memname">GLM_FUNC_DECL genIUType glm::mod </td>
  88. <td>(</td>
  89. <td class="paramtype">genIUType&#160;</td>
  90. <td class="paramname"><em>x</em>, </td>
  91. </tr>
  92. <tr>
  93. <td class="paramkey"></td>
  94. <td></td>
  95. <td class="paramtype">genIUType&#160;</td>
  96. <td class="paramname"><em>y</em>&#160;</td>
  97. </tr>
  98. <tr>
  99. <td></td>
  100. <td>)</td>
  101. <td></td><td></td>
  102. </tr>
  103. </table>
  104. </div><div class="memdoc">
  105. <p>Modulus. </p>
  106. <p>Returns x % y for each component in x using the floating point value y.</p>
  107. <dl class="tparams"><dt>Template Parameters</dt><dd>
  108. <table class="tparams">
  109. <tr><td class="paramname">genIUType</td><td>Integer-point scalar or vector types.</td></tr>
  110. </table>
  111. </dd>
  112. </dl>
  113. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  114. <dd>
  115. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  116. <dd>
  117. <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>
  118. </div>
  119. </div>
  120. <a class="anchor" id="gac76ae7d82ff22526bcf6d6a1b51af6c3"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
  126. <td>(</td>
  127. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  128. <td class="paramname"><em>x</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">T&#160;</td>
  134. <td class="paramname"><em>y</em>&#160;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Modulus. </p>
  144. <p>Returns x % y for each component in x using the floating point value y.</p>
  145. <dl class="tparams"><dt>Template Parameters</dt><dd>
  146. <table class="tparams">
  147. <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
  148. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  149. </table>
  150. </dd>
  151. </dl>
  152. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  153. <dd>
  154. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  155. <dd>
  156. <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>
  157. </div>
  158. </div>
  159. <a class="anchor" id="gaf5ae5330f6b30b4a35fb95f9a73d6134"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
  165. <td>(</td>
  166. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  167. <td class="paramname"><em>x</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  173. <td class="paramname"><em>y</em>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Modulus. </p>
  183. <p>Returns x % y for each component in x using the floating point value y.</p>
  184. <dl class="tparams"><dt>Template Parameters</dt><dd>
  185. <table class="tparams">
  186. <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
  187. <tr><td class="paramname">vecType</td><td>vector types.</td></tr>
  188. </table>
  189. </dd>
  190. </dl>
  191. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
  192. <dd>
  193. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
  194. <dd>
  195. <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>
  196. </div>
  197. </div>
  198. </div><!-- contents -->
  199. <!-- start footer part -->
  200. <hr class="footer"/><address class="footer"><small>
  201. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  202. <img class="footer" src="doxygen.png" alt="doxygen"/>
  203. </a> 1.8.8
  204. </small></address>
  205. </body>
  206. </html>