mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

255
doc/api/a00210.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_vector_angle</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_matrix_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>
@@ -15,18 +16,23 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -35,42 +41,56 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_vector_angle</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_matrix_query<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </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:gaff9a524d6451772dc6df11f8880498fa"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<tr class="memitem:gaff9a524d6451772dc6df11f8880498fa"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gaff9a524d6451772dc6df11f8880498fa">angle</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
<tr class="separator:gaff9a524d6451772dc6df11f8880498fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4268cbf9472bcaeeab131626f8971301"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga4268cbf9472bcaeeab131626f8971301"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga4268cbf9472bcaeeab131626f8971301">orientedAngle</a> (detail::tvec2&lt; T &gt; const &amp;x, detail::tvec2&lt; T &gt; const &amp;y)</td></tr>
<tr class="separator:ga4268cbf9472bcaeeab131626f8971301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f15db506641d5f9461259672b7f276c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga3f15db506641d5f9461259672b7f276c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga3f15db506641d5f9461259672b7f276c">orientedAngle</a> (detail::tvec3&lt; T &gt; const &amp;x, detail::tvec3&lt; T &gt; const &amp;y, detail::tvec3&lt; T &gt; const &amp;ref)</td></tr>
<tr class="separator:ga3f15db506641d5f9461259672b7f276c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabedf650c2fb3a6062d96dd979b809f51"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gabedf650c2fb3a6062d96dd979b809f51"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gabedf650c2fb3a6062d96dd979b809f51">isIdentity</a> (genType const &amp;m, typename genType::T const &amp;epsilon)</td></tr>
<tr class="separator:gabedf650c2fb3a6062d96dd979b809f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb6ab065655de7ae74220c893181b682"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gaeb6ab065655de7ae74220c893181b682"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a> (detail::tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:gaeb6ab065655de7ae74220c893181b682"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c9e974205cc07336c104e68dbd3ad9b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga2c9e974205cc07336c104e68dbd3ad9b"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga2c9e974205cc07336c104e68dbd3ad9b">isNormalized</a> (detail::tmat3x3&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:ga2c9e974205cc07336c104e68dbd3ad9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga402e460226bcb826e5b78384ccab3914"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga402e460226bcb826e5b78384ccab3914"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga402e460226bcb826e5b78384ccab3914">isNormalized</a> (detail::tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:ga402e460226bcb826e5b78384ccab3914"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca2ae6e3b473e36c0bf0fcf50d0b972b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gaca2ae6e3b473e36c0bf0fcf50d0b972b"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a> (detail::tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:gaca2ae6e3b473e36c0bf0fcf50d0b972b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac75325aa247da1cc443612393059c456"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gac75325aa247da1cc443612393059c456"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gac75325aa247da1cc443612393059c456">isNull</a> (detail::tmat3x3&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:gac75325aa247da1cc443612393059c456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabb8199aea46b55255dad1af1a5426acb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gabb8199aea46b55255dad1af1a5426acb"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gabb8199aea46b55255dad1af1a5426acb">isNull</a> (detail::tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:gabb8199aea46b55255dad1af1a5426acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fe1957e1f5935a9b7b6e61417d41aa4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga4fe1957e1f5935a9b7b6e61417d41aa4"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga4fe1957e1f5935a9b7b6e61417d41aa4">isOrthogonal</a> (matType&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
<tr class="separator:ga4fe1957e1f5935a9b7b6e61417d41aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Compute angle between vectors. </p>
<p>&lt;<a class="el" href="a00121.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/vector_angle.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Query to evaluate matrix properties. </p>
<p>&lt;<a class="el" href="a00079.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_query.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaff9a524d6451772dc6df11f8880498fa"></a>
<a class="anchor" id="gabedf650c2fb3a6062d96dd979b809f51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_QUALIFIER vecType::value_type glm::angle </td>
<td class="memname">bool glm::isIdentity </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">typename genType::T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -80,26 +100,26 @@ vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a c
</table>
</div><div class="memdoc">
<p>Returns the absolute angle between two vectors Parameters need to be normalized. </p>
<p>From GLM_GTX_vector_angle extension </p>
<p>Return whether a matrix is an identity matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="ga4268cbf9472bcaeeab131626f8971301"></a>
<a class="anchor" id="gaeb6ab065655de7ae74220c893181b682"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_QUALIFIER T glm::orientedAngle </td>
<td class="memname">bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">detail::tmat2x2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -109,32 +129,26 @@ vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a c
</table>
</div><div class="memdoc">
<p>Returns the oriented angle between two 2d vectors Parameters need to be normalized. </p>
<p>From GLM_GTX_vector_angle extension. </p>
<p>Return whether a matrix is a normalized matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="ga3f15db506641d5f9461259672b7f276c"></a>
<a class="anchor" id="ga2c9e974205cc07336c104e68dbd3ad9b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_QUALIFIER T glm::orientedAngle </td>
<td class="memname">bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">detail::tmat3x3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>ref</em>&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -144,8 +158,153 @@ vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a c
</table>
</div><div class="memdoc">
<p>Returns the oriented angle between two 3d vectors based from a reference axis. </p>
<p>Parameters need to be normalized. From GLM_GTX_vector_angle extension. </p>
<p>Return whether a matrix is a normalized matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="ga402e460226bcb826e5b78384ccab3914"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</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>Return whether a matrix is a normalized matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="gaca2ae6e3b473e36c0bf0fcf50d0b972b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNull </td>
<td>(</td>
<td class="paramtype">detail::tmat2x2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</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>Return whether a matrix a null matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="gac75325aa247da1cc443612393059c456"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNull </td>
<td>(</td>
<td class="paramtype">detail::tmat3x3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</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>Return whether a matrix a null matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="gabb8199aea46b55255dad1af1a5426acb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNull </td>
<td>(</td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</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>Return whether a matrix is a null matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
<a class="anchor" id="ga4fe1957e1f5935a9b7b6e61417d41aa4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isOrthogonal </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</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>Return whether a matrix is an orthonormalized matrix. </p>
<p>From GLM_GTX_matrix_query extension. </p>
</div>
</div>
@@ -154,7 +313,7 @@ vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a c
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</a> 1.8.5
</small></address>
</body>
</html>