mirror of
https://github.com/g-truc/glm.git
synced 2024-11-10 12:41:54 +00:00
338 lines
17 KiB
HTML
338 lines
17 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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>GLM: Vector Relational Functions</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">GLM
|
|
 <span id="projectnumber">0.9.5</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Vector Relational Functions<div class="ingroups"><a class="el" href="a00167.html">GLM Core</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga14bbc94f2ae2774a1d64d91f8767773e">all</a> (vecType< bool, P > const &v)</td></tr>
|
|
<tr class="separator:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga632a2644532d9332011c8860400d30b2"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga632a2644532d9332011c8860400d30b2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga632a2644532d9332011c8860400d30b2">any</a> (vecType< bool, P > const &v)</td></tr>
|
|
<tr class="separator:ga632a2644532d9332011c8860400d30b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac9163d451231eb3eaae2c6b3da5add6a"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:gac9163d451231eb3eaae2c6b3da5add6a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P ><br class="typebreak"/>
|
|
::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gac9163d451231eb3eaae2c6b3da5add6a">greaterThan</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
|
<tr class="separator:gac9163d451231eb3eaae2c6b3da5add6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad1385064aa2fc7aaae37aa95daea9c31"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:gad1385064aa2fc7aaae37aa95daea9c31"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P ><br class="typebreak"/>
|
|
::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gad1385064aa2fc7aaae37aa95daea9c31">greaterThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
|
<tr class="separator:gad1385064aa2fc7aaae37aa95daea9c31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2167b22ac086c5791a4740932b62b685"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga2167b22ac086c5791a4740932b62b685"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P ><br class="typebreak"/>
|
|
::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga2167b22ac086c5791a4740932b62b685">lessThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
|
<tr class="separator:ga2167b22ac086c5791a4740932b62b685"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga4329ecbc2ef012c9ec704bd09da1f177">not_</a> (vecType< bool, P > const &v)</td></tr>
|
|
<tr class="separator:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga85d7bc5613c4dcc2d5873ec9d6ed4c19"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga85d7bc5613c4dcc2d5873ec9d6ed4c19"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P ><br class="typebreak"/>
|
|
::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga85d7bc5613c4dcc2d5873ec9d6ed4c19">notEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
|
<tr class="separator:ga85d7bc5613c4dcc2d5873ec9d6ed4c19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. </p>
|
|
<p>For vector results, use the following built-in functions.</p>
|
|
<p>In all cases, the sizes of all the input and return vectors for any particular call must match. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga14bbc94f2ae2774a1d64d91f8767773e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL bool glm::all </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool, P > const & </td>
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if all components of x are true. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga632a2644532d9332011c8860400d30b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL bool glm::any </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool, P > const & </td>
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if any component of x is true. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac9163d451231eb3eaae2c6b3da5add6a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vecType<T, P>::bool_type glm::greaterThan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the component-wise comparison of result x > y. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad1385064aa2fc7aaae37aa95daea9c31"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vecType<T, P>::bool_type glm::greaterThanEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the component-wise comparison of result x >= y. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2167b22ac086c5791a4740932b62b685"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vecType<T, P>::bool_type glm::lessThanEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the component-wise comparison result of x < y. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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> Returns the component-wise comparison of result x <= y.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4329ecbc2ef012c9ec704bd09da1f177"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::not_ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool, P > const & </td>
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the component-wise logical complement of x. </p>
|
|
<p>/!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga85d7bc5613c4dcc2d5873ec9d6ed4c19"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vecType<T, P>::bool_type glm::notEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the component-wise comparison of result x == y. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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> Returns the component-wise comparison of result x != y.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<dd>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|