glm/doc/html/a00133.html
Christophe Riccio 7c7b1d0b3d Added GLM 0.8.4
2010-04-29 11:54:07 +01:00

314 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM: glm::core::function::vector_relational Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
</ul>
</div>
<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>
</div>
</div>
<div class="contents">
<h1>glm::core::function::vector_relational Namespace Reference</h1>
<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.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x == y. <a href="#acd61db14c5aaa2754b1afac24f136430"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<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>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise logical complement of x. <a href="#a3e130e9f8308e36693bb74248449ef45"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<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>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the component-wise compare of x != y. <a href="#acadb83d01dd2b41eb58e87f99a1e790f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a4d9f51b13cdf600d1e835f97e05720bc"></a><!-- doxytag: member="glm::core::function::vector_relational::all" ref="a4d9f51b13cdf600d1e835f97e05720bc" args="(vecType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::core::function::vector_relational::all </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if all components of x are true. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<a class="anchor" id="a637eb3070a2cc9d579c4372e6bd46aa7"></a><!-- doxytag: member="glm::core::function::vector_relational::any" ref="a637eb3070a2cc9d579c4372e6bd46aa7" args="(vecType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::core::function::vector_relational::any </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if any component of x is true. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::equal </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x == y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::greaterThan </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x &gt; y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::greaterThanEqual </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x &gt;= y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::lessThan </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x &lt; y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::lessThanEqual </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x &lt;= y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<a class="anchor" id="a3e130e9f8308e36693bb74248449ef45"></a><!-- doxytag: member="glm::core::function::vector_relational::not_" ref="a3e130e9f8308e36693bb74248449ef45" args="(vecType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::not_ </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise logical complement of x. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType::bool_type glm::core::function::vector_relational::notEqual </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the component-wise compare of x != y. </p>
<p>(From GLSL 1.30.08 specification, section 8.6) </p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>