mirror of
https://github.com/g-truc/glm.git
synced 2024-11-16 06:44:35 +00:00
403 lines
17 KiB
HTML
403 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"/>
|
|
|
|
<title>Vector Relational Functions</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div! -->
|
|
|
|
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<!-- Generated by Doxygen 1.7.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="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Vector Relational Functions</div> </div>
|
|
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga349edc1a383fff08c6d577428416a73b">all</a> (vecType< bool > const &v)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga7141e1fafe91560d8c8789901d1c1271">any</a> (vecType< bool > const &v)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaeded4966b21a46182176fc6e24e05fdd">equal</a> (vecType const &x, vecType const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gabd72ae0dc35908eaa143568fb42c3830">greaterThan</a> (vecType const &x, vecType const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gac9b3c898e70adc1e573300b1a8e66e9f">greaterThanEqual</a> (vecType const &x, vecType const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga1227d6a9d2c15a57d8189c5d9f4d9c53">lessThan</a> (vecType const &x, vecType const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga6199b9a55616b7b872b0bf0658b239ce">lessThanEqual</a> (vecType const &x, vecType const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType< bool > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gac44e885cf2f0b0896124d7ce5df6ed4f">not_</a> (vecType< bool > const &v)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga20caef2fbce3eacb97e895f2ed315271">notEqual</a> (vecType const &x, vecType const &y)</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>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>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="ga349edc1a383fff08c6d577428416a73b"></a><!-- doxytag: member="glm::all" ref="ga349edc1a383fff08c6d577428416a73b" args="(vecType< bool > const &v)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool glm::all </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool > 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="ga7141e1fafe91560d8c8789901d1c1271"></a><!-- doxytag: member="glm::any" ref="ga7141e1fafe91560d8c8789901d1c1271" args="(vecType< bool > const &v)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool glm::any </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool > 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="gaeded4966b21a46182176fc6e24e05fdd"></a><!-- doxytag: member="glm::equal" ref="gaeded4966b21a46182176fc6e24e05fdd" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::equal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="gabd72ae0dc35908eaa143568fb42c3830"></a><!-- doxytag: member="glm::greaterThan" ref="gabd72ae0dc35908eaa143568fb42c3830" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::greaterThan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="gac9b3c898e70adc1e573300b1a8e66e9f"></a><!-- doxytag: member="glm::greaterThanEqual" ref="gac9b3c898e70adc1e573300b1a8e66e9f" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::greaterThanEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="ga1227d6a9d2c15a57d8189c5d9f4d9c53"></a><!-- doxytag: member="glm::lessThan" ref="ga1227d6a9d2c15a57d8189c5d9f4d9c53" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::lessThan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="ga6199b9a55616b7b872b0bf0658b239ce"></a><!-- doxytag: member="glm::lessThanEqual" ref="ga6199b9a55616b7b872b0bf0658b239ce" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::lessThanEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point or integer vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="gac44e885cf2f0b0896124d7ce5df6ed4f"></a><!-- doxytag: member="glm::not_" ref="gac44e885cf2f0b0896124d7ce5df6ed4f" args="(vecType< bool > const &v)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType<bool> glm::not_ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< bool > 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Boolean vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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="ga20caef2fbce3eacb97e895f2ed315271"></a><!-- doxytag: member="glm::notEqual" ref="ga20caef2fbce3eacb97e895f2ed315271" args="(vecType const &x, vecType const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vecType::bool_type glm::notEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType 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><dt><b>Template Parameters:</b></dt><dd>
|
|
<table class="">
|
|
<tr><td class="paramname">vecType</td><td>Floating-point, integer or boolean vector types. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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>
|
|
|
|
|
|
<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.7.5
|
|
</small></address>
|
|
|
|
</body>
|
|
</html>
|