a00292.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  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 documentation: 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 documentation
  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="a00286.html">Recommended extensions</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Include &lt;<a class="el" href="a00041.html" title="GLM_GTC_integer ">glm/gtc/integer.hpp</a>&gt; to use the features of this extension.
  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:ga57824268ebe13a922f1d69a5d37f637f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:ga57824268ebe13a922f1d69a5d37f637f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, int, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00292.html#ga57824268ebe13a922f1d69a5d37f637f">iround</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  89. <tr class="memdesc:ga57824268ebe13a922f1d69a5d37f637f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00292.html#ga57824268ebe13a922f1d69a5d37f637f">More...</a><br /></td></tr>
  90. <tr class="separator:ga57824268ebe13a922f1d69a5d37f637f"><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="a00292.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="a00292.html#ga9bd682e74bfacb005c735305207ec417">More...</a><br /></td></tr>
  94. <tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  96. <tr class="memitem:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, uint, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00292.html#ga6715b9d573972a0f7763d30d45bcaec4">uround</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  97. <tr class="memdesc:ga6715b9d573972a0f7763d30d45bcaec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00292.html#ga6715b9d573972a0f7763d30d45bcaec4">More...</a><br /></td></tr>
  98. <tr class="separator:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <p>Include &lt;<a class="el" href="a00041.html" title="GLM_GTC_integer ">glm/gtc/integer.hpp</a>&gt; to use the features of this extension. </p>
  102. <p>Allow to perform bit operations on integer values </p>
  103. <h2 class="groupheader">Function Documentation</h2>
  104. <a class="anchor" id="ga57824268ebe13a922f1d69a5d37f637f"></a>
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">GLM_FUNC_DECL vec&lt;L, int, Q&gt; glm::iround </td>
  110. <td>(</td>
  111. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  112. <td class="paramname"><em>x</em></td><td>)</td>
  113. <td></td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. <p>Returns a value equal to the nearest integer to x. </p>
  118. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
  119. <dl class="params"><dt>Parameters</dt><dd>
  120. <table class="params">
  121. <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
  122. </table>
  123. </dd>
  124. </dl>
  125. <dl class="tparams"><dt>Template Parameters</dt><dd>
  126. <table class="tparams">
  127. <tr><td class="paramname">T</td><td>floating point scalar types.</td></tr>
  128. </table>
  129. </dd>
  130. </dl>
  131. <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>
  132. <dd>
  133. <a class="el" href="a00292.html" title="Include <glm/gtc/integer.hpp> to use the features of this extension. ">GLM_GTC_integer</a> </dd></dl>
  134. </div>
  135. </div>
  136. <a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td>
  142. <td>(</td>
  143. <td class="paramtype">genIUType&#160;</td>
  144. <td class="paramname"><em>x</em></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Returns the log2 of x for integer values. </p>
  150. <p>Usefull to compute mipmap count from the texture size. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00292.html" title="Include <glm/gtc/integer.hpp> to use the features of this extension. ">GLM_GTC_integer</a> </dd></dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ga6715b9d573972a0f7763d30d45bcaec4"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL vec&lt;L, uint, Q&gt; glm::uround </td>
  159. <td>(</td>
  160. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  161. <td class="paramname"><em>x</em></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Returns a value equal to the nearest integer to x. </p>
  167. <p>The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest.</p>
  168. <dl class="params"><dt>Parameters</dt><dd>
  169. <table class="params">
  170. <tr><td class="paramname">x</td><td>The values of the argument must be greater or equal to zero. </td></tr>
  171. </table>
  172. </dd>
  173. </dl>
  174. <dl class="tparams"><dt>Template Parameters</dt><dd>
  175. <table class="tparams">
  176. <tr><td class="paramname">T</td><td>floating point scalar types.</td></tr>
  177. </table>
  178. </dd>
  179. </dl>
  180. <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>
  181. <dd>
  182. <a class="el" href="a00292.html" title="Include <glm/gtc/integer.hpp> to use the features of this extension. ">GLM_GTC_integer</a> </dd></dl>
  183. </div>
  184. </div>
  185. </div><!-- contents -->
  186. <!-- start footer part -->
  187. <hr class="footer"/><address class="footer"><small>
  188. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  189. <img class="footer" src="doxygen.png" alt="doxygen"/>
  190. </a> 1.8.10
  191. </small></address>
  192. </body>
  193. </html>