a00133.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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>GLM: glm::core::function::vector_relational Namespace Reference</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. <!-- Generated by Doxygen 1.6.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15. <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  16. <li><a href="files.html"><span>Files</span></a></li>
  17. </ul>
  18. </div>
  19. <div class="tabs">
  20. <ul>
  21. <li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li>
  22. <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
  23. </ul>
  24. </div>
  25. <div class="navpath"><a class="el" href="a00124.html">glm</a>::<a class="el" href="a00125.html">core</a>::<a class="el" href="a00126.html">function</a>::<a class="el" href="a00133.html">vector_relational</a>
  26. </div>
  27. </div>
  28. <div class="contents">
  29. <h1>glm::core::function::vector_relational Namespace Reference</h1>
  30. <p>Define vector relational functions from Section 8.3 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace.
  31. <a href="#_details">More...</a></p>
  32. <table border="0" cellpadding="0" cellspacing="0">
  33. <tr><td colspan="2"><h2>Functions</h2></td></tr>
  34. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  35. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a4d9f51b13cdf600d1e835f97e05720bc">all</a> (vecType const &amp;x)</td></tr>
  36. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if all components of x are true. <a href="#a4d9f51b13cdf600d1e835f97e05720bc"></a><br/></td></tr>
  37. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  38. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a637eb3070a2cc9d579c4372e6bd46aa7">any</a> (vecType const &amp;x)</td></tr>
  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if any component of x is true. <a href="#a637eb3070a2cc9d579c4372e6bd46aa7"></a><br/></td></tr>
  40. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  41. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#acd61db14c5aaa2754b1afac24f136430">equal</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  42. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x == y. <a href="#acd61db14c5aaa2754b1afac24f136430"></a><br/></td></tr>
  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  44. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a1b09a81ae06e58af62b7bdfed7c2c853">greaterThan</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x &gt; y. <a href="#a1b09a81ae06e58af62b7bdfed7c2c853"></a><br/></td></tr>
  46. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  47. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a2283fc765396791e26bb22522de7f0f5">greaterThanEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x &gt;= y. <a href="#a2283fc765396791e26bb22522de7f0f5"></a><br/></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&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#aa57d098b5dacde48aaa4896943cb1ebf">lessThan</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x &lt; y. <a href="#aa57d098b5dacde48aaa4896943cb1ebf"></a><br/></td></tr>
  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  53. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a8b780976ba02aec5a44624f30aa4ab97">lessThanEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x &lt;= y. <a href="#a8b780976ba02aec5a44624f30aa4ab97"></a><br/></td></tr>
  55. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  56. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#a3e130e9f8308e36693bb74248449ef45">not_</a> (vecType const &amp;x)</td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise logical complement of x. <a href="#a3e130e9f8308e36693bb74248449ef45"></a><br/></td></tr>
  58. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
  59. <tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00133.html#acadb83d01dd2b41eb58e87f99a1e790f">notEqual</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x != y. <a href="#acadb83d01dd2b41eb58e87f99a1e790f"></a><br/></td></tr>
  61. </table>
  62. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  63. <p>Define vector relational functions from Section 8.3 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace. </p>
  64. <hr/><h2>Function Documentation</h2>
  65. <a class="anchor" id="a4d9f51b13cdf600d1e835f97e05720bc"></a><!-- doxytag: member="glm::core::function::vector_relational::all" ref="a4d9f51b13cdf600d1e835f97e05720bc" args="(vecType const &amp;x)" -->
  66. <div class="memitem">
  67. <div class="memproto">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname">bool glm::core::function::vector_relational::all </td>
  71. <td>(</td>
  72. <td class="paramtype">vecType const &amp;&nbsp;</td>
  73. <td class="paramname"> <em>x</em></td>
  74. <td>&nbsp;)&nbsp;</td>
  75. <td></td>
  76. </tr>
  77. </table>
  78. </div>
  79. <div class="memdoc">
  80. <p>Returns true if all components of x are true. </p>
  81. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  82. </div>
  83. </div>
  84. <a class="anchor" id="a637eb3070a2cc9d579c4372e6bd46aa7"></a><!-- doxytag: member="glm::core::function::vector_relational::any" ref="a637eb3070a2cc9d579c4372e6bd46aa7" args="(vecType const &amp;x)" -->
  85. <div class="memitem">
  86. <div class="memproto">
  87. <table class="memname">
  88. <tr>
  89. <td class="memname">bool glm::core::function::vector_relational::any </td>
  90. <td>(</td>
  91. <td class="paramtype">vecType const &amp;&nbsp;</td>
  92. <td class="paramname"> <em>x</em></td>
  93. <td>&nbsp;)&nbsp;</td>
  94. <td></td>
  95. </tr>
  96. </table>
  97. </div>
  98. <div class="memdoc">
  99. <p>Returns true if any component of x is true. </p>
  100. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  101. </div>
  102. </div>
  103. <a class="anchor" id="acd61db14c5aaa2754b1afac24f136430"></a><!-- doxytag: member="glm::core::function::vector_relational::equal" ref="acd61db14c5aaa2754b1afac24f136430" args="(vecType const &amp;x, vecType const &amp;y)" -->
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">vecType::bool_type glm::core::function::vector_relational::equal </td>
  109. <td>(</td>
  110. <td class="paramtype">vecType const &amp;&nbsp;</td>
  111. <td class="paramname"> <em>x</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype">vecType const &amp;&nbsp;</td>
  117. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  118. </tr>
  119. <tr>
  120. <td></td>
  121. <td>)</td>
  122. <td></td><td></td><td></td>
  123. </tr>
  124. </table>
  125. </div>
  126. <div class="memdoc">
  127. <p>Returns the component-wise compare of x == y. </p>
  128. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  129. </div>
  130. </div>
  131. <a class="anchor" id="a1b09a81ae06e58af62b7bdfed7c2c853"></a><!-- doxytag: member="glm::core::function::vector_relational::greaterThan" ref="a1b09a81ae06e58af62b7bdfed7c2c853" args="(vecType const &amp;x, vecType const &amp;y)" -->
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">vecType::bool_type glm::core::function::vector_relational::greaterThan </td>
  137. <td>(</td>
  138. <td class="paramtype">vecType const &amp;&nbsp;</td>
  139. <td class="paramname"> <em>x</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">vecType const &amp;&nbsp;</td>
  145. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  146. </tr>
  147. <tr>
  148. <td></td>
  149. <td>)</td>
  150. <td></td><td></td><td></td>
  151. </tr>
  152. </table>
  153. </div>
  154. <div class="memdoc">
  155. <p>Returns the component-wise compare of x &gt; y. </p>
  156. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  157. </div>
  158. </div>
  159. <a class="anchor" id="a2283fc765396791e26bb22522de7f0f5"></a><!-- doxytag: member="glm::core::function::vector_relational::greaterThanEqual" ref="a2283fc765396791e26bb22522de7f0f5" args="(vecType const &amp;x, vecType const &amp;y)" -->
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">vecType::bool_type glm::core::function::vector_relational::greaterThanEqual </td>
  165. <td>(</td>
  166. <td class="paramtype">vecType const &amp;&nbsp;</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 const &amp;&nbsp;</td>
  173. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td><td></td>
  179. </tr>
  180. </table>
  181. </div>
  182. <div class="memdoc">
  183. <p>Returns the component-wise compare of x &gt;= y. </p>
  184. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="aa57d098b5dacde48aaa4896943cb1ebf"></a><!-- doxytag: member="glm::core::function::vector_relational::lessThan" ref="aa57d098b5dacde48aaa4896943cb1ebf" args="(vecType const &amp;x, vecType const &amp;y)" -->
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">vecType::bool_type glm::core::function::vector_relational::lessThan </td>
  193. <td>(</td>
  194. <td class="paramtype">vecType const &amp;&nbsp;</td>
  195. <td class="paramname"> <em>x</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">vecType const &amp;&nbsp;</td>
  201. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  202. </tr>
  203. <tr>
  204. <td></td>
  205. <td>)</td>
  206. <td></td><td></td><td></td>
  207. </tr>
  208. </table>
  209. </div>
  210. <div class="memdoc">
  211. <p>Returns the component-wise compare of x &lt; y. </p>
  212. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  213. </div>
  214. </div>
  215. <a class="anchor" id="a8b780976ba02aec5a44624f30aa4ab97"></a><!-- doxytag: member="glm::core::function::vector_relational::lessThanEqual" ref="a8b780976ba02aec5a44624f30aa4ab97" args="(vecType const &amp;x, vecType const &amp;y)" -->
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">vecType::bool_type glm::core::function::vector_relational::lessThanEqual </td>
  221. <td>(</td>
  222. <td class="paramtype">vecType const &amp;&nbsp;</td>
  223. <td class="paramname"> <em>x</em>, </td>
  224. </tr>
  225. <tr>
  226. <td class="paramkey"></td>
  227. <td></td>
  228. <td class="paramtype">vecType const &amp;&nbsp;</td>
  229. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  230. </tr>
  231. <tr>
  232. <td></td>
  233. <td>)</td>
  234. <td></td><td></td><td></td>
  235. </tr>
  236. </table>
  237. </div>
  238. <div class="memdoc">
  239. <p>Returns the component-wise compare of x &lt;= y. </p>
  240. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a3e130e9f8308e36693bb74248449ef45"></a><!-- doxytag: member="glm::core::function::vector_relational::not_" ref="a3e130e9f8308e36693bb74248449ef45" args="(vecType const &amp;x)" -->
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">vecType::bool_type glm::core::function::vector_relational::not_ </td>
  249. <td>(</td>
  250. <td class="paramtype">vecType const &amp;&nbsp;</td>
  251. <td class="paramname"> <em>x</em></td>
  252. <td>&nbsp;)&nbsp;</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div>
  257. <div class="memdoc">
  258. <p>Returns the component-wise logical complement of x. </p>
  259. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  260. </div>
  261. </div>
  262. <a class="anchor" id="acadb83d01dd2b41eb58e87f99a1e790f"></a><!-- doxytag: member="glm::core::function::vector_relational::notEqual" ref="acadb83d01dd2b41eb58e87f99a1e790f" args="(vecType const &amp;x, vecType const &amp;y)" -->
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">vecType::bool_type glm::core::function::vector_relational::notEqual </td>
  268. <td>(</td>
  269. <td class="paramtype">vecType const &amp;&nbsp;</td>
  270. <td class="paramname"> <em>x</em>, </td>
  271. </tr>
  272. <tr>
  273. <td class="paramkey"></td>
  274. <td></td>
  275. <td class="paramtype">vecType const &amp;&nbsp;</td>
  276. <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
  277. </tr>
  278. <tr>
  279. <td></td>
  280. <td>)</td>
  281. <td></td><td></td><td></td>
  282. </tr>
  283. </table>
  284. </div>
  285. <div class="memdoc">
  286. <p>Returns the component-wise compare of x != y. </p>
  287. <p>(From GLSL 1.30.08 specification, section 8.6) </p>
  288. </div>
  289. </div>
  290. </div>
  291. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
  292. <a href="http://www.doxygen.org/index.html">
  293. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  294. </body>
  295. </html>