a00932.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  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_common</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="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_GTX_common<div class="ingroups"><a class="el" href="a00905.html">Experimental extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Provide functions to increase the compatibility with Cg and HLSL languages.
  70. <a href="#details">More...</a></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  73. Functions</h2></td></tr>
  74. <tr class="memitem:gab7d89c14c48ad01f720fb5daf8813161"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  75. <tr class="memitem:gab7d89c14c48ad01f720fb5daf8813161"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00932.html#gab7d89c14c48ad01f720fb5daf8813161">closeBounded</a> (vec&lt; L, T, Q &gt; const &amp;Value, vec&lt; L, T, Q &gt; const &amp;Min, vec&lt; L, T, Q &gt; const &amp;Max)</td></tr>
  76. <tr class="memdesc:gab7d89c14c48ad01f720fb5daf8813161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether vector components values are within an interval. <a href="a00932.html#gab7d89c14c48ad01f720fb5daf8813161">More...</a><br /></td></tr>
  77. <tr class="separator:gab7d89c14c48ad01f720fb5daf8813161"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:gae5e80425df9833164ad469e83b475fb4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  79. <tr class="memitem:gae5e80425df9833164ad469e83b475fb4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00932.html#gae5e80425df9833164ad469e83b475fb4">fmod</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
  80. <tr class="memdesc:gae5e80425df9833164ad469e83b475fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to 'mod' but with a different rounding and integer support. <a href="a00932.html#gae5e80425df9833164ad469e83b475fb4">More...</a><br /></td></tr>
  81. <tr class="separator:gae5e80425df9833164ad469e83b475fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  83. <tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00932.html#ga74aa7c7462245d83bd5a9edf9c6c2d91">isdenormal</a> (genType const &amp;x)</td></tr>
  84. <tr class="memdesc:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if x is a denormalized number Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format. <a href="a00932.html#ga74aa7c7462245d83bd5a9edf9c6c2d91">More...</a><br /></td></tr>
  85. <tr class="separator:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:gafd303042ba2ba695bf53b2315f53f93f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  87. <tr class="memitem:gafd303042ba2ba695bf53b2315f53f93f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00932.html#gafd303042ba2ba695bf53b2315f53f93f">openBounded</a> (vec&lt; L, T, Q &gt; const &amp;Value, vec&lt; L, T, Q &gt; const &amp;Min, vec&lt; L, T, Q &gt; const &amp;Max)</td></tr>
  88. <tr class="memdesc:gafd303042ba2ba695bf53b2315f53f93f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether vector components values are within an interval. <a href="a00932.html#gafd303042ba2ba695bf53b2315f53f93f">More...</a><br /></td></tr>
  89. <tr class="separator:gafd303042ba2ba695bf53b2315f53f93f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <p>Provide functions to increase the compatibility with Cg and HLSL languages. </p>
  93. <p>Include &lt;<a class="el" href="a01687.html" title="GLM_GTX_common">glm/gtx/common.hpp</a>&gt; to use the features of this extension. </p>
  94. <h2 class="groupheader">Function Documentation</h2>
  95. <a id="gab7d89c14c48ad01f720fb5daf8813161"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#gab7d89c14c48ad01f720fb5daf8813161">&#9670;&nbsp;</a></span>closeBounded()</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::closeBounded </td>
  102. <td>(</td>
  103. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  104. <td class="paramname"><em>Value</em>, </td>
  105. </tr>
  106. <tr>
  107. <td class="paramkey"></td>
  108. <td></td>
  109. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  110. <td class="paramname"><em>Min</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  116. <td class="paramname"><em>Max</em>&#160;</td>
  117. </tr>
  118. <tr>
  119. <td></td>
  120. <td>)</td>
  121. <td></td><td></td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Returns whether vector components values are within an interval. </p>
  126. <p>A closed interval includes its endpoints, and is denoted with square brackets.</p>
  127. <dl class="tparams"><dt>Template Parameters</dt><dd>
  128. <table class="tparams">
  129. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  130. <tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
  131. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  132. </table>
  133. </dd>
  134. </dl>
  135. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00890.html">GLM_EXT_vector_relational</a> </dd></dl>
  136. </div>
  137. </div>
  138. <a id="gae5e80425df9833164ad469e83b475fb4"></a>
  139. <h2 class="memtitle"><span class="permalink"><a href="#gae5e80425df9833164ad469e83b475fb4">&#9670;&nbsp;</a></span>fmod()</h2>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::fmod </td>
  145. <td>(</td>
  146. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  147. <td class="paramname"><em>v</em></td><td>)</td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>Similar to 'mod' but with a different rounding and integer support. </p>
  153. <p>Returns 'x - y * trunc(x/y)' instead of 'x - y * floor(x/y)'</p>
  154. <dl class="section see"><dt>See also</dt><dd><a href="http://stackoverflow.com/questions/7610631/glsl-mod-vs-hlsl-fmod">GLSL mod vs HLSL fmod</a> </dd>
  155. <dd>
  156. <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd></dl>
  157. </div>
  158. </div>
  159. <a id="ga74aa7c7462245d83bd5a9edf9c6c2d91"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#ga74aa7c7462245d83bd5a9edf9c6c2d91">&#9670;&nbsp;</a></span>isdenormal()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">GLM_FUNC_DECL genType::bool_type glm::isdenormal </td>
  166. <td>(</td>
  167. <td class="paramtype">genType const &amp;&#160;</td>
  168. <td class="paramname"><em>x</em></td><td>)</td>
  169. <td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Returns true if x is a denormalized number Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format. </p>
  174. <p>This format is less precise but can represent values closer to zero.</p>
  175. <dl class="tparams"><dt>Template Parameters</dt><dd>
  176. <table class="tparams">
  177. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  178. </table>
  179. </dd>
  180. </dl>
  181. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/isnan.xml">GLSL isnan man page</a> </dd>
  182. <dd>
  183. <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>
  184. </div>
  185. </div>
  186. <a id="gafd303042ba2ba695bf53b2315f53f93f"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#gafd303042ba2ba695bf53b2315f53f93f">&#9670;&nbsp;</a></span>openBounded()</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::openBounded </td>
  193. <td>(</td>
  194. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  195. <td class="paramname"><em>Value</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  201. <td class="paramname"><em>Min</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  207. <td class="paramname"><em>Max</em>&#160;</td>
  208. </tr>
  209. <tr>
  210. <td></td>
  211. <td>)</td>
  212. <td></td><td></td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Returns whether vector components values are within an interval. </p>
  217. <p>A open interval excludes its endpoints, and is denoted with square brackets.</p>
  218. <dl class="tparams"><dt>Template Parameters</dt><dd>
  219. <table class="tparams">
  220. <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
  221. <tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
  222. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  223. </table>
  224. </dd>
  225. </dl>
  226. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00890.html">GLM_EXT_vector_relational</a> </dd></dl>
  227. </div>
  228. </div>
  229. </div><!-- contents -->
  230. <!-- start footer part -->
  231. <hr class="footer"/><address class="footer"><small>
  232. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  233. <img class="footer" src="doxygen.png" alt="doxygen"/>
  234. </a> 1.8.18
  235. </small></address>
  236. </body>
  237. </html>