diff options
Diffstat (limited to '3rdparty/glm/doc/api/a00152.html')
| -rw-r--r-- | 3rdparty/glm/doc/api/a00152.html | 349 |
1 files changed, 234 insertions, 115 deletions
diff --git a/3rdparty/glm/doc/api/a00152.html b/3rdparty/glm/doc/api/a00152.html index 7a82558d891..6b61073fc6f 100644 --- a/3rdparty/glm/doc/api/a00152.html +++ b/3rdparty/glm/doc/api/a00152.html @@ -4,10 +4,16 @@ <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.10"/> -<title>0.9.7: Exponential functions</title> +<title>0.9.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -16,9 +22,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> + <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">0.9.7 + <div id="projectname">0.9.9 API documenation </div> </td> </tr> @@ -27,231 +33,282 @@ </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.10 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> </ul> </div> </div><!-- top --> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Exponential functions<div class="ingroups"><a class="el" href="a00162.html">GLM Core</a></div></div> </div> +<div class="title">Vector Relational Functions<div class="ingroups"><a class="el" href="a00155.html">GLM Core</a></div></div> </div> </div><!--header--> <div class="contents"> + +<p>Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. +<a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga25e54a7f44fc49ec6ac6ffc7675cf04a">exp</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga42ca440d9062f1f456f5a9e896378f9c">exp2</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga599103d4fe4ef2234761ba8da7268627"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga599103d4fe4ef2234761ba8da7268627"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga599103d4fe4ef2234761ba8da7268627">inversesqrt</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:ga599103d4fe4ef2234761ba8da7268627"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga21efca311e62d233de0ae96bab126b83"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga21efca311e62d233de0ae96bab126b83"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga21efca311e62d233de0ae96bab126b83">log</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:ga21efca311e62d233de0ae96bab126b83"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gabae30945338a555a03733f00dad95d0d"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gabae30945338a555a03733f00dad95d0d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gabae30945338a555a03733f00dad95d0d">log2</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:gabae30945338a555a03733f00dad95d0d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga082b332a4b7c6ad1d43e09ff19e214dd">pow</a> (vecType< T, P > const &base, vecType< T, P > const &exponent)</td></tr> -<tr class="separator:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gae7ac2e44c14d4e8004098d0bfba6e2b8"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gae7ac2e44c14d4e8004098d0bfba6e2b8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gae7ac2e44c14d4e8004098d0bfba6e2b8">sqrt</a> (vecType< T, P > const &v)</td></tr> -<tr class="separator:gae7ac2e44c14d4e8004098d0bfba6e2b8"><td class="memSeparator" colspan="2"> </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="a00152.html#ga14bbc94f2ae2774a1d64d91f8767773e">all</a> (vecType< bool, P > const &v)</td></tr> +<tr class="memdesc:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if all components of x are true. <a href="a00152.html#ga14bbc94f2ae2774a1d64d91f8767773e">More...</a><br /></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="a00152.html#ga632a2644532d9332011c8860400d30b2">any</a> (vecType< bool, P > const &v)</td></tr> +<tr class="memdesc:ga632a2644532d9332011c8860400d30b2"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if any component of x is true. <a href="a00152.html#ga632a2644532d9332011c8860400d30b2">More...</a><br /></td></tr> +<tr class="separator:ga632a2644532d9332011c8860400d30b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga39c80d8baf49b0ce69f2bb22d45b3801">equal</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x == y. <a href="a00152.html#ga39c80d8baf49b0ce69f2bb22d45b3801">More...</a><br /></td></tr> +<tr class="separator:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadd80263161a308462d3e3e287e79cccd"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gadd80263161a308462d3e3e287e79cccd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gadd80263161a308462d3e3e287e79cccd">greaterThan</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:gadd80263161a308462d3e3e287e79cccd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x > y. <a href="a00152.html#gadd80263161a308462d3e3e287e79cccd">More...</a><br /></td></tr> +<tr class="separator:gadd80263161a308462d3e3e287e79cccd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gaee7e101f8cc4ea43924f14dcdeb2ef26">greaterThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x >= y. <a href="a00152.html#gaee7e101f8cc4ea43924f14dcdeb2ef26">More...</a><br /></td></tr> +<tr class="separator:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6261970937a70b0b747ae0d3ade1c188"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga6261970937a70b0b747ae0d3ade1c188"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga6261970937a70b0b747ae0d3ade1c188">lessThan</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:ga6261970937a70b0b747ae0d3ade1c188"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison result of x < y. <a href="a00152.html#ga6261970937a70b0b747ae0d3ade1c188">More...</a><br /></td></tr> +<tr class="separator:ga6261970937a70b0b747ae0d3ade1c188"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf1d88119f11200c32011de7c5ec0102"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gaaf1d88119f11200c32011de7c5ec0102"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gaaf1d88119f11200c32011de7c5ec0102">lessThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:gaaf1d88119f11200c32011de7c5ec0102"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x <= y. <a href="a00152.html#gaaf1d88119f11200c32011de7c5ec0102">More...</a><br /></td></tr> +<tr class="separator:gaaf1d88119f11200c32011de7c5ec0102"><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="a00152.html#ga4329ecbc2ef012c9ec704bd09da1f177">not_</a> (vecType< bool, P > const &v)</td></tr> +<tr class="memdesc:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise logical complement of x. <a href="a00152.html#ga4329ecbc2ef012c9ec704bd09da1f177">More...</a><br /></td></tr> +<tr class="separator:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5aca2b745e5eb0096716bbc394846309"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga5aca2b745e5eb0096716bbc394846309"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga5aca2b745e5eb0096716bbc394846309">notEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> +<tr class="memdesc:ga5aca2b745e5eb0096716bbc394846309"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x != y. <a href="a00152.html#ga5aca2b745e5eb0096716bbc394846309">More...</a><br /></td></tr> +<tr class="separator:ga5aca2b745e5eb0096716bbc394846309"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>These all operate component-wise. </p> -<p>The description is per component. </p> +<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="ga25e54a7f44fc49ec6ac6ffc7675cf04a"></a> +<a class="anchor" id="ga14bbc94f2ae2774a1d64d91f8767773e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::exp </td> + <td class="memname">GLM_FUNC_DECL bool glm::all </td> <td>(</td> - <td class="paramtype">vecType< T, P > const & </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 natural exponentiation of x, i.e., e^x. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>exp function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> - </table> - </dd> -</dl> +<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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/exp.xml">GLSL exp man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="ga42ca440d9062f1f456f5a9e896378f9c"></a> +<a class="anchor" id="ga632a2644532d9332011c8860400d30b2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::exp2 </td> + <td class="memname">GLM_FUNC_DECL bool glm::any </td> <td>(</td> - <td class="paramtype">vecType< T, P > const & </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 2 raised to the v power. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>exp2 function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> - </table> - </dd> -</dl> +<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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/exp2.xml">GLSL exp2 man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="ga599103d4fe4ef2234761ba8da7268627"></a> +<a class="anchor" id="ga39c80d8baf49b0ce69f2bb22d45b3801"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::inversesqrt </td> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::equal </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</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 reciprocal of the positive square root of v. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>inversesqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type precision. </td></tr> - </table> - </dd> -</dl> +<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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/inversesqrt.xml">GLSL inversesqrt man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="ga21efca311e62d233de0ae96bab126b83"></a> +<a class="anchor" id="gadd80263161a308462d3e3e287e79cccd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::log </td> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::greaterThan </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</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 natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. </p> -<p>Results are undefined if v <= 0.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>log function is defined for input values of v defined in the range (0, inf+) in the limit of the type precision. </td></tr> - </table> - </dd> -</dl> +<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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/log.xml">GLSL log man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="gabae30945338a555a03733f00dad95d0d"></a> +<a class="anchor" id="gaee7e101f8cc4ea43924f14dcdeb2ef26"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::log2 </td> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::greaterThanEqual </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</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 base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>log2 function is defined for input values of v defined in the range (0, inf+) in the limit of the type precision. </td></tr> - </table> - </dd> -</dl> +<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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/log2.xml">GLSL log2 man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="ga082b332a4b7c6ad1d43e09ff19e214dd"></a> +<a class="anchor" id="ga6261970937a70b0b747ae0d3ade1c188"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::pow </td> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::lessThan </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>base</em>, </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>exponent</em> </td> + <td class="paramname"><em>y</em> </td> </tr> <tr> <td></td> @@ -261,56 +318,118 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Returns 'base' raised to the power 'exponent'. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">base</td><td>Floating point value. pow function is defined for input values of 'base' defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> - <tr><td class="paramname">exponent</td><td>Floating point value representing the 'exponent'. </td></tr> +<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="gaaf1d88119f11200c32011de7c5ec0102"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> 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 of result x <= y. </p> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/pow.xml">GLSL pow man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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="gae7ac2e44c14d4e8004098d0bfba6e2b8"></a> +<a class="anchor" id="ga4329ecbc2ef012c9ec704bd09da1f177"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::sqrt </td> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::not_ </td> <td>(</td> - <td class="paramtype">vecType< T, P > const & </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 positive square root of v. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">v</td><td>sqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type precision. </td></tr> +<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="ga5aca2b745e5eb0096716bbc394846309"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">GLM_FUNC_DECL vecType<bool, P> 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">genType</td><td>Floating-point scalar or vector types.</td></tr> + <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/sqrt.xml">GLSL sqrt man page</a> </dd> +<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.2 Exponential Functions</a> </dd></dl> +<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> |
