mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen API doc

Browse Source
This commit is contained in:
Christophe Riccio
2016-11-13 00:39:32 +01:00
parent 83d14ee411
commit d8ca117cb6
394 changed files with 48595 additions and 40958 deletions
Download Patch File Download Diff File Expand all files Collapse all files

236
doc/api/a00235.html
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.8: GLM_GTX_type_trait</title>
<title>0.9.8 API documenation: GLM_GTX_vector_query</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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.8
<div id="projectname">0.9.8 API documenation
</div>
</td>
</tr>
@@ -36,13 +36,239 @@
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_type_trait<div class="ingroups"><a class="el" href="a00155.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_vector_query<div class="ingroups"><a class="el" href="a00154.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Query informations of vector types.
<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:ga465b844190d1740051e45d780832ea4c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga465b844190d1740051e45d780832ea4c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga465b844190d1740051e45d780832ea4c">areCollinear</a> (vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga465b844190d1740051e45d780832ea4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are collinears. <a href="a00235.html#ga465b844190d1740051e45d780832ea4c">More...</a><br /></td></tr>
<tr class="separator:ga465b844190d1740051e45d780832ea4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee10acefed397c11e01f2862e837754c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gaee10acefed397c11e01f2862e837754c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#gaee10acefed397c11e01f2862e837754c">areOrthogonal</a> (vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:gaee10acefed397c11e01f2862e837754c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthogonals. <a href="a00235.html#gaee10acefed397c11e01f2862e837754c">More...</a><br /></td></tr>
<tr class="separator:gaee10acefed397c11e01f2862e837754c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89c82bc60e5b84e4489b74c15a134caf"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga89c82bc60e5b84e4489b74c15a134caf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga89c82bc60e5b84e4489b74c15a134caf">areOrthonormal</a> (vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga89c82bc60e5b84e4489b74c15a134caf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthonormal. <a href="a00235.html#ga89c82bc60e5b84e4489b74c15a134caf">More...</a><br /></td></tr>
<tr class="separator:ga89c82bc60e5b84e4489b74c15a134caf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93ecd4137480483ce1af0de8bbbf6546"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga93ecd4137480483ce1af0de8bbbf6546"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga93ecd4137480483ce1af0de8bbbf6546">isCompNull</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga93ecd4137480483ce1af0de8bbbf6546"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a each component of a vector is null. <a href="a00235.html#ga93ecd4137480483ce1af0de8bbbf6546">More...</a><br /></td></tr>
<tr class="separator:ga93ecd4137480483ce1af0de8bbbf6546"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6fa5fa2af67d14c205d24c49aad03270"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga6fa5fa2af67d14c205d24c49aad03270"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga6fa5fa2af67d14c205d24c49aad03270">isNormalized</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga6fa5fa2af67d14c205d24c49aad03270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is normalized. <a href="a00235.html#ga6fa5fa2af67d14c205d24c49aad03270">More...</a><br /></td></tr>
<tr class="separator:ga6fa5fa2af67d14c205d24c49aad03270"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81a64edc1a2b470b82896592e89c523b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga81a64edc1a2b470b82896592e89c523b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga81a64edc1a2b470b82896592e89c523b">isNull</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga81a64edc1a2b470b82896592e89c523b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is null. <a href="a00235.html#ga81a64edc1a2b470b82896592e89c523b">More...</a><br /></td></tr>
<tr class="separator:ga81a64edc1a2b470b82896592e89c523b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Defines traits for each type. </p>
<p>&lt;<a class="el" href="a00126.html" title="GLM_GTX_type_trait ">glm/gtx/type_trait.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Query informations of vector types. </p>
<p>&lt;<a class="el" href="a00137.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga465b844190d1740051e45d780832ea4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areCollinear </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are collinears. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="gaee10acefed397c11e01f2862e837754c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areOrthogonal </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are orthogonals. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga89c82bc60e5b84e4489b74c15a134caf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areOrthonormal </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are orthonormal. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga93ecd4137480483ce1af0de8bbbf6546"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;bool, P&gt; glm::isCompNull </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a each component of a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6fa5fa2af67d14c205d24c49aad03270"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is normalized. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga81a64edc1a2b470b82896592e89c523b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNull </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00235.html" title="Query informations of vector types. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>