| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389 |
- <!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"/>
- <title>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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.2 -->
- <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="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> </div>
- <div class="ingroups"><a class="el" href="a00141.html">GLM Core</a></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:ga349edc1a383fff08c6d577428416a73b"><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
- <tr class="memitem:ga349edc1a383fff08c6d577428416a73b"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga349edc1a383fff08c6d577428416a73b">all</a> (vecType< bool > const &v)</td></tr>
- <tr class="separator:ga349edc1a383fff08c6d577428416a73b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7141e1fafe91560d8c8789901d1c1271"><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
- <tr class="memitem:ga7141e1fafe91560d8c8789901d1c1271"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga7141e1fafe91560d8c8789901d1c1271">any</a> (vecType< bool > const &v)</td></tr>
- <tr class="separator:ga7141e1fafe91560d8c8789901d1c1271"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaeded4966b21a46182176fc6e24e05fdd"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:gaeded4966b21a46182176fc6e24e05fdd"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gaeded4966b21a46182176fc6e24e05fdd">equal</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:gaeded4966b21a46182176fc6e24e05fdd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gabd72ae0dc35908eaa143568fb42c3830"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:gabd72ae0dc35908eaa143568fb42c3830"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gabd72ae0dc35908eaa143568fb42c3830">greaterThan</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:gabd72ae0dc35908eaa143568fb42c3830"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gac9b3c898e70adc1e573300b1a8e66e9f">greaterThanEqual</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:gac9b3c898e70adc1e573300b1a8e66e9f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga1227d6a9d2c15a57d8189c5d9f4d9c53">lessThan</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:ga1227d6a9d2c15a57d8189c5d9f4d9c53"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga6199b9a55616b7b872b0bf0658b239ce">lessThanEqual</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:ga6199b9a55616b7b872b0bf0658b239ce"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memTemplParams" colspan="2">template<template< typename > class vecType> </td></tr>
- <tr class="memitem:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memTemplItemLeft" align="right" valign="top">vecType< bool > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#gac44e885cf2f0b0896124d7ce5df6ed4f">not_</a> (vecType< bool > const &v)</td></tr>
- <tr class="separator:gac44e885cf2f0b0896124d7ce5df6ed4f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga20caef2fbce3eacb97e895f2ed315271"><td class="memTemplParams" colspan="2">template<typename vecType > </td></tr>
- <tr class="memitem:ga20caef2fbce3eacb97e895f2ed315271"><td class="memTemplItemLeft" align="right" valign="top">vecType::bool_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00137.html#ga20caef2fbce3eacb97e895f2ed315271">notEqual</a> (vecType const &x, vecType const &y)</td></tr>
- <tr class="separator:ga20caef2fbce3eacb97e895f2ed315271"><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="ga349edc1a383fff08c6d577428416a73b"></a>
- <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 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="ga7141e1fafe91560d8c8789901d1c1271"></a>
- <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 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="gaeded4966b21a46182176fc6e24e05fdd"></a>
- <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 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> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gabd72ae0dc35908eaa143568fb42c3830"></a>
- <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 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="gac9b3c898e70adc1e573300b1a8e66e9f"></a>
- <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 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="ga1227d6a9d2c15a57d8189c5d9f4d9c53"></a>
- <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 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> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga6199b9a55616b7b872b0bf0658b239ce"></a>
- <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 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="gac44e885cf2f0b0896124d7ce5df6ed4f"></a>
- <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 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="ga20caef2fbce3eacb97e895f2ed315271"></a>
- <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 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.2
- </small></address>
- </body>
- </html>
|