a00137.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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. <title>Vector Relational Functions</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  19. </tr>
  20. </tbody>
  21. </table>
  22. </div>
  23. <!-- end header part -->
  24. <!-- Generated by Doxygen 1.8.2 -->
  25. <div id="navrow1" class="tabs">
  26. <ul class="tablist">
  27. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29. <li><a href="modules.html"><span>Modules</span></a></li>
  30. <li><a href="files.html"><span>Files</span></a></li>
  31. </ul>
  32. </div>
  33. </div><!-- top -->
  34. <div class="header">
  35. <div class="summary">
  36. <a href="#func-members">Functions</a> </div>
  37. <div class="headertitle">
  38. <div class="title">Vector Relational Functions</div> </div>
  39. <div class="ingroups"><a class="el" href="a00141.html">GLM Core</a></div></div><!--header-->
  40. <div class="contents">
  41. <table class="memberdecls">
  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  43. Functions</h2></td></tr>
  44. <tr class="memitem:ga349edc1a383fff08c6d577428416a73b"><td class="memTemplParams" colspan="2">template&lt;template&lt; typename &gt; class vecType&gt; </td></tr>
  45. <tr class="memitem:ga349edc1a383fff08c6d577428416a73b"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga349edc1a383fff08c6d577428416a73b">all</a> (vecType&lt; bool &gt; const &amp;v)</td></tr>
  46. <tr class="separator:ga349edc1a383fff08c6d577428416a73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:ga7141e1fafe91560d8c8789901d1c1271"><td class="memTemplParams" colspan="2">template&lt;template&lt; typename &gt; class vecType&gt; </td></tr>
  48. <tr class="memitem:ga7141e1fafe91560d8c8789901d1c1271"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga7141e1fafe91560d8c8789901d1c1271">any</a> (vecType&lt; bool &gt; const &amp;v)</td></tr>
  49. <tr class="separator:ga7141e1fafe91560d8c8789901d1c1271"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:gaeded4966b21a46182176fc6e24e05fdd"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  51. <tr class="memitem:gaeded4966b21a46182176fc6e24e05fdd"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gaeded4966b21a46182176fc6e24e05fdd">equal</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  52. <tr class="separator:gaeded4966b21a46182176fc6e24e05fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gabd72ae0dc35908eaa143568fb42c3830"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  54. <tr class="memitem:gabd72ae0dc35908eaa143568fb42c3830"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gabd72ae0dc35908eaa143568fb42c3830">greaterThan</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  55. <tr class="separator:gabd72ae0dc35908eaa143568fb42c3830"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  57. <tr class="memitem:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gac9b3c898e70adc1e573300b1a8e66e9f">greaterThanEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  58. <tr class="separator:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  60. <tr class="memitem:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga1227d6a9d2c15a57d8189c5d9f4d9c53">lessThan</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  61. <tr class="separator:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  63. <tr class="memitem:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga6199b9a55616b7b872b0bf0658b239ce">lessThanEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  64. <tr class="separator:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memTemplParams" colspan="2">template&lt;template&lt; typename &gt; class vecType&gt; </td></tr>
  66. <tr class="memitem:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memTemplItemLeft" align="right" valign="top">vecType&lt; bool &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gac44e885cf2f0b0896124d7ce5df6ed4f">not_</a> (vecType&lt; bool &gt; const &amp;v)</td></tr>
  67. <tr class="separator:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga20caef2fbce3eacb97e895f2ed315271"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  69. <tr class="memitem:ga20caef2fbce3eacb97e895f2ed315271"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga20caef2fbce3eacb97e895f2ed315271">notEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  70. <tr class="separator:ga20caef2fbce3eacb97e895f2ed315271"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. </table>
  72. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  73. <p>Relational and equality operators (&lt;, &lt;=, &gt;, &gt;=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. </p>
  74. <p>For vector results, use the following built-in functions.</p>
  75. <p>In all cases, the sizes of all the input and return vectors for any particular call must match. </p>
  76. <h2 class="groupheader">Function Documentation</h2>
  77. <a class="anchor" id="ga349edc1a383fff08c6d577428416a73b"></a>
  78. <div class="memitem">
  79. <div class="memproto">
  80. <table class="memname">
  81. <tr>
  82. <td class="memname">bool glm::all </td>
  83. <td>(</td>
  84. <td class="paramtype">vecType&lt; bool &gt; const &amp;&#160;</td>
  85. <td class="paramname"><em>v</em></td><td>)</td>
  86. <td></td>
  87. </tr>
  88. </table>
  89. </div><div class="memdoc">
  90. <p>Returns true if all components of x are true. </p>
  91. <dl class="tparams"><dt>Template Parameters</dt><dd>
  92. <table class="tparams">
  93. <tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
  94. </table>
  95. </dd>
  96. </dl>
  97. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/all.xml">GLSL all man page</a> </dd>
  98. <dd>
  99. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  100. </div>
  101. </div>
  102. <a class="anchor" id="ga7141e1fafe91560d8c8789901d1c1271"></a>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">bool glm::any </td>
  108. <td>(</td>
  109. <td class="paramtype">vecType&lt; bool &gt; const &amp;&#160;</td>
  110. <td class="paramname"><em>v</em></td><td>)</td>
  111. <td></td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. <p>Returns true if any component of x is true. </p>
  116. <dl class="tparams"><dt>Template Parameters</dt><dd>
  117. <table class="tparams">
  118. <tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
  119. </table>
  120. </dd>
  121. </dl>
  122. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/any.xml">GLSL any man page</a> </dd>
  123. <dd>
  124. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  125. </div>
  126. </div>
  127. <a class="anchor" id="gaeded4966b21a46182176fc6e24e05fdd"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">vecType::bool_type glm::equal </td>
  133. <td>(</td>
  134. <td class="paramtype">vecType const &amp;&#160;</td>
  135. <td class="paramname"><em>x</em>, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">vecType const &amp;&#160;</td>
  141. <td class="paramname"><em>y</em>&#160;</td>
  142. </tr>
  143. <tr>
  144. <td></td>
  145. <td>)</td>
  146. <td></td><td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Returns the component-wise comparison of result x == y. </p>
  151. <dl class="tparams"><dt>Template Parameters</dt><dd>
  152. <table class="tparams">
  153. <tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr>
  154. </table>
  155. </dd>
  156. </dl>
  157. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/equal.xml">GLSL equal man page</a> </dd>
  158. <dd>
  159. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  160. </div>
  161. </div>
  162. <a class="anchor" id="gabd72ae0dc35908eaa143568fb42c3830"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">vecType::bool_type glm::greaterThan </td>
  168. <td>(</td>
  169. <td class="paramtype">vecType const &amp;&#160;</td>
  170. <td class="paramname"><em>x</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">vecType const &amp;&#160;</td>
  176. <td class="paramname"><em>y</em>&#160;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Returns the component-wise comparison of result x &gt; y. </p>
  186. <dl class="tparams"><dt>Template Parameters</dt><dd>
  187. <table class="tparams">
  188. <tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
  189. </table>
  190. </dd>
  191. </dl>
  192. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThan.xml">GLSL greaterThan man page</a> </dd>
  193. <dd>
  194. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="gac9b3c898e70adc1e573300b1a8e66e9f"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">vecType::bool_type glm::greaterThanEqual </td>
  203. <td>(</td>
  204. <td class="paramtype">vecType const &amp;&#160;</td>
  205. <td class="paramname"><em>x</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">vecType const &amp;&#160;</td>
  211. <td class="paramname"><em>y</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Returns the component-wise comparison of result x &gt;= y. </p>
  221. <dl class="tparams"><dt>Template Parameters</dt><dd>
  222. <table class="tparams">
  223. <tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
  224. </table>
  225. </dd>
  226. </dl>
  227. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThanEqual.xml">GLSL greaterThanEqual man page</a> </dd>
  228. <dd>
  229. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a class="anchor" id="ga1227d6a9d2c15a57d8189c5d9f4d9c53"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">vecType::bool_type glm::lessThan </td>
  238. <td>(</td>
  239. <td class="paramtype">vecType const &amp;&#160;</td>
  240. <td class="paramname"><em>x</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">vecType const &amp;&#160;</td>
  246. <td class="paramname"><em>y</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Returns the component-wise comparison result of x &lt; y. </p>
  256. <dl class="tparams"><dt>Template Parameters</dt><dd>
  257. <table class="tparams">
  258. <tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
  259. </table>
  260. </dd>
  261. </dl>
  262. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThan.xml">GLSL lessThan man page</a> </dd>
  263. <dd>
  264. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  265. </div>
  266. </div>
  267. <a class="anchor" id="ga6199b9a55616b7b872b0bf0658b239ce"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">vecType::bool_type glm::lessThanEqual </td>
  273. <td>(</td>
  274. <td class="paramtype">vecType const &amp;&#160;</td>
  275. <td class="paramname"><em>x</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">vecType const &amp;&#160;</td>
  281. <td class="paramname"><em>y</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Returns the component-wise comparison of result x &lt;= y. </p>
  291. <dl class="tparams"><dt>Template Parameters</dt><dd>
  292. <table class="tparams">
  293. <tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
  294. </table>
  295. </dd>
  296. </dl>
  297. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThanEqual.xml">GLSL lessThanEqual man page</a> </dd>
  298. <dd>
  299. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  300. </div>
  301. </div>
  302. <a class="anchor" id="gac44e885cf2f0b0896124d7ce5df6ed4f"></a>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">vecType&lt;bool&gt; glm::not_ </td>
  308. <td>(</td>
  309. <td class="paramtype">vecType&lt; bool &gt; const &amp;&#160;</td>
  310. <td class="paramname"><em>v</em></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Returns the component-wise logical complement of x. </p>
  316. <p>/!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.</p>
  317. <dl class="tparams"><dt>Template Parameters</dt><dd>
  318. <table class="tparams">
  319. <tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
  320. </table>
  321. </dd>
  322. </dl>
  323. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/not.xml">GLSL not man page</a> </dd>
  324. <dd>
  325. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  326. </div>
  327. </div>
  328. <a class="anchor" id="ga20caef2fbce3eacb97e895f2ed315271"></a>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">vecType::bool_type glm::notEqual </td>
  334. <td>(</td>
  335. <td class="paramtype">vecType const &amp;&#160;</td>
  336. <td class="paramname"><em>x</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">vecType const &amp;&#160;</td>
  342. <td class="paramname"><em>y</em>&#160;</td>
  343. </tr>
  344. <tr>
  345. <td></td>
  346. <td>)</td>
  347. <td></td><td></td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Returns the component-wise comparison of result x != y. </p>
  352. <dl class="tparams"><dt>Template Parameters</dt><dd>
  353. <table class="tparams">
  354. <tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr>
  355. </table>
  356. </dd>
  357. </dl>
  358. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/notEqual.xml">GLSL notEqual man page</a> </dd>
  359. <dd>
  360. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7 Vector Relational Functions</a> </dd></dl>
  361. </div>
  362. </div>
  363. </div><!-- contents -->
  364. <!-- start footer part -->
  365. <hr class="footer"/><address class="footer"><small>
  366. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  367. <img class="footer" src="doxygen.png" alt="doxygen"/>
  368. </a> 1.8.2
  369. </small></address>
  370. </body>
  371. </html>