Updated API doc

This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions

View File

@@ -4,7 +4,7 @@
<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.9 API documenation: func_vector_relational.hpp File Reference</title>
<title>0.9.9 API documenation: integer.hpp File Reference</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>
@@ -79,66 +79,56 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_da256b9dd32ba43e2eaa8a2832c37f1b.html">detail</a></li> </ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_7997edb062bdde9a99cb6835d42b0d9d.html">gtc</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">func_vector_relational.hpp File Reference</div> </div>
<div class="title">gtc/integer.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="a00158.html">GLM Core</a>
<p><a class="el" href="a00153.html">GLM_GTC_integer</a>
<a href="#details">More...</a></p>
<p><a href="a00039_source.html">Go to the source code of this file.</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:ga8ad7a8bdde263e80a50f82dd1074ec26"><td class="memTemplParams" colspan="2">template&lt;length_t L, qualifier P&gt; </td></tr>
<tr class="memitem:ga8ad7a8bdde263e80a50f82dd1074ec26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga8ad7a8bdde263e80a50f82dd1074ec26">all</a> (vec&lt; L, bool, P &gt; const &amp;v)</td></tr>
<tr class="memdesc:ga8ad7a8bdde263e80a50f82dd1074ec26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if all components of x are true. <a href="a00155.html#ga8ad7a8bdde263e80a50f82dd1074ec26">More...</a><br /></td></tr>
<tr class="separator:ga8ad7a8bdde263e80a50f82dd1074ec26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0447219f8b5899b71f5151c6d38d1bad"><td class="memTemplParams" colspan="2">template&lt;length_t L, qualifier P&gt; </td></tr>
<tr class="memitem:ga0447219f8b5899b71f5151c6d38d1bad"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga0447219f8b5899b71f5151c6d38d1bad">any</a> (vec&lt; L, bool, P &gt; const &amp;v)</td></tr>
<tr class="memdesc:ga0447219f8b5899b71f5151c6d38d1bad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if any component of x is true. <a href="a00155.html#ga0447219f8b5899b71f5151c6d38d1bad">More...</a><br /></td></tr>
<tr class="separator:ga0447219f8b5899b71f5151c6d38d1bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3586c7b47874d31fc90991ab30332c5f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga3586c7b47874d31fc90991ab30332c5f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga3586c7b47874d31fc90991ab30332c5f">equal</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga3586c7b47874d31fc90991ab30332c5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x == y. <a href="a00155.html#ga3586c7b47874d31fc90991ab30332c5f">More...</a><br /></td></tr>
<tr class="separator:ga3586c7b47874d31fc90991ab30332c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e4a8001f2c679598449cc7c6bbcf791"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga2e4a8001f2c679598449cc7c6bbcf791"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga2e4a8001f2c679598449cc7c6bbcf791">greaterThan</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga2e4a8001f2c679598449cc7c6bbcf791"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &gt; y. <a href="a00155.html#ga2e4a8001f2c679598449cc7c6bbcf791">More...</a><br /></td></tr>
<tr class="separator:ga2e4a8001f2c679598449cc7c6bbcf791"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa11dfd6fab6b08bb1c697032a67365a1"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gaa11dfd6fab6b08bb1c697032a67365a1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#gaa11dfd6fab6b08bb1c697032a67365a1">greaterThanEqual</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:gaa11dfd6fab6b08bb1c697032a67365a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &gt;= y. <a href="a00155.html#gaa11dfd6fab6b08bb1c697032a67365a1">More...</a><br /></td></tr>
<tr class="separator:gaa11dfd6fab6b08bb1c697032a67365a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b9b83dde116b37ed7d628180efaccb4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga0b9b83dde116b37ed7d628180efaccb4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga0b9b83dde116b37ed7d628180efaccb4">lessThan</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga0b9b83dde116b37ed7d628180efaccb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison result of x &lt; y. <a href="a00155.html#ga0b9b83dde116b37ed7d628180efaccb4">More...</a><br /></td></tr>
<tr class="separator:ga0b9b83dde116b37ed7d628180efaccb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8509bcb77cb3b67acbd3f355b87d70c"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gaf8509bcb77cb3b67acbd3f355b87d70c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#gaf8509bcb77cb3b67acbd3f355b87d70c">lessThanEqual</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:gaf8509bcb77cb3b67acbd3f355b87d70c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &lt;= y. <a href="a00155.html#gaf8509bcb77cb3b67acbd3f355b87d70c">More...</a><br /></td></tr>
<tr class="separator:gaf8509bcb77cb3b67acbd3f355b87d70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9ced2e21c1e5f8820eb351da7baa5b4"><td class="memTemplParams" colspan="2">template&lt;length_t L, qualifier P&gt; </td></tr>
<tr class="memitem:gaf9ced2e21c1e5f8820eb351da7baa5b4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#gaf9ced2e21c1e5f8820eb351da7baa5b4">not_</a> (vec&lt; L, bool, P &gt; const &amp;v)</td></tr>
<tr class="memdesc:gaf9ced2e21c1e5f8820eb351da7baa5b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise logical complement of x. <a href="a00155.html#gaf9ced2e21c1e5f8820eb351da7baa5b4">More...</a><br /></td></tr>
<tr class="separator:gaf9ced2e21c1e5f8820eb351da7baa5b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63026227bb8e1cbb3765468d556844eb"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga63026227bb8e1cbb3765468d556844eb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00155.html#ga63026227bb8e1cbb3765468d556844eb">notEqual</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga63026227bb8e1cbb3765468d556844eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x != y. <a href="a00155.html#ga63026227bb8e1cbb3765468d556844eb">More...</a><br /></td></tr>
<tr class="separator:ga63026227bb8e1cbb3765468d556844eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57824268ebe13a922f1d69a5d37f637f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga57824268ebe13a922f1d69a5d37f637f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, int, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga57824268ebe13a922f1d69a5d37f637f">iround</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
<tr class="memdesc:ga57824268ebe13a922f1d69a5d37f637f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00153.html#ga57824268ebe13a922f1d69a5d37f637f">More...</a><br /></td></tr>
<tr class="separator:ga57824268ebe13a922f1d69a5d37f637f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga9bd682e74bfacb005c735305207ec417">log2</a> (genIUType x)</td></tr>
<tr class="memdesc:ga9bd682e74bfacb005c735305207ec417"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the log2 of x for integer values. <a href="a00153.html#ga9bd682e74bfacb005c735305207ec417">More...</a><br /></td></tr>
<tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a> (genIUType x, genIUType y)</td></tr>
<tr class="memdesc:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">More...</a><br /></td></tr>
<tr class="separator:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad32bcde4977c7a42c80468f4061a1f55"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gad32bcde4977c7a42c80468f4061a1f55"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00140.html#gad32bcde4977c7a42c80468f4061a1f55">mod</a> (vec&lt; L, T, Q &gt; const &amp;x, T y)</td></tr>
<tr class="memdesc:gad32bcde4977c7a42c80468f4061a1f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00140.html#gad32bcde4977c7a42c80468f4061a1f55">More...</a><br /></td></tr>
<tr class="separator:gad32bcde4977c7a42c80468f4061a1f55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f8acc481ba553dc0e6be1aedf1ee61c"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga5f8acc481ba553dc0e6be1aedf1ee61c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00140.html#ga5f8acc481ba553dc0e6be1aedf1ee61c">mod</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga5f8acc481ba553dc0e6be1aedf1ee61c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modulus. <a href="a00140.html#ga5f8acc481ba553dc0e6be1aedf1ee61c">More...</a><br /></td></tr>
<tr class="separator:ga5f8acc481ba553dc0e6be1aedf1ee61c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, uint, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga6715b9d573972a0f7763d30d45bcaec4">uround</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
<tr class="memdesc:ga6715b9d573972a0f7763d30d45bcaec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a value equal to the nearest integer to x. <a href="a00153.html#ga6715b9d573972a0f7763d30d45bcaec4">More...</a><br /></td></tr>
<tr class="separator:ga6715b9d573972a0f7763d30d45bcaec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00158.html">GLM Core</a> </p>
<dl class="section see"><dt>See also</dt><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 class="textblock"><p><a class="el" href="a00153.html">GLM_GTC_integer</a> </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00143.html" title="Features that implement in C++ the GLSL specification as closely as possible. ">Core features</a> (dependence) </dd>
<dd>
<a class="el" href="a00153.html" title="Include <glm/gtc/integer.hpp> to use the features of this extension. ">GLM_GTC_integer</a> (dependence) </dd></dl>
<p>Definition in file <a class="el" href="a00039_source.html">func_vector_relational.hpp</a>.</p>
<p>Definition in file <a class="el" href="a00039_source.html">gtc/integer.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>