a00135.html 17 KB

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