Updated API documentation

2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 deletions
--- a/doc/api/a00208.html
+++ b/doc/api/a00208.html
@@ -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.7: GLM_GTX_matrix_decompose</title>
+<title>0.9.8: 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>
@@ -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.7
+   <div id="projectname">0.9.8
   </div>
  </td>
 </tr>
@@ -39,59 +39,56 @@
  <div class="summary">
 <a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
-<div class="title">GLM_GTX_matrix_decompose<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div>  </div>
+<div class="title">GLM_GTX_matrix_query<div class="ingroups"><a class="el" href="a00155.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:ga0f1245817507156b337798a253577c8b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
-<tr class="memitem:ga0f1245817507156b337798a253577c8b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga0f1245817507156b337798a253577c8b">decompose</a> (tmat4x4&lt; T, P &gt; const &amp;modelMatrix, tvec3&lt; T, P &gt; &amp;scale, tquat&lt; T, P &gt; &amp;orientation, tvec3&lt; T, P &gt; &amp;translation, tvec3&lt; T, P &gt; &amp;skew, tvec4&lt; T, P &gt; &amp;perspective)</td></tr>
-<tr class="separator:ga0f1245817507156b337798a253577c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gafc1ce12c738b8c5d007179e615609330"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
+<tr class="memitem:gafc1ce12c738b8c5d007179e615609330"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#gafc1ce12c738b8c5d007179e615609330">isIdentity</a> (matType&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:gafc1ce12c738b8c5d007179e615609330"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga11a8d5cdb36496b85f61e4f5f7f2602c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:ga11a8d5cdb36496b85f61e4f5f7f2602c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga11a8d5cdb36496b85f61e4f5f7f2602c">isNormalized</a> (tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:ga11a8d5cdb36496b85f61e4f5f7f2602c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga351bcc8d485d329b78cfa875e084964d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:ga351bcc8d485d329b78cfa875e084964d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga351bcc8d485d329b78cfa875e084964d">isNormalized</a> (tmat3x3&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:ga351bcc8d485d329b78cfa875e084964d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga934b673ec0e16d79eca0ca9dbb5d6d8b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:ga934b673ec0e16d79eca0ca9dbb5d6d8b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga934b673ec0e16d79eca0ca9dbb5d6d8b">isNormalized</a> (tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:ga934b673ec0e16d79eca0ca9dbb5d6d8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga37e535cbeaea383b8c1247b98875cd4b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:ga37e535cbeaea383b8c1247b98875cd4b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga37e535cbeaea383b8c1247b98875cd4b">isNull</a> (tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:ga37e535cbeaea383b8c1247b98875cd4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gac67a5c7e029a84b74b02ac9599b8972d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:gac67a5c7e029a84b74b02ac9599b8972d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#gac67a5c7e029a84b74b02ac9599b8972d">isNull</a> (tmat3x3&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:gac67a5c7e029a84b74b02ac9599b8972d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga326de496972051413c7b44b85fc9cb6e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
+<tr class="memitem:ga326de496972051413c7b44b85fc9cb6e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#ga326de496972051413c7b44b85fc9cb6e">isNull</a> (tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:ga326de496972051413c7b44b85fc9cb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab2cb5d23df77b4e4e63ad2965acd31b3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
+<tr class="memitem:gab2cb5d23df77b4e4e63ad2965acd31b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00208.html#gab2cb5d23df77b4e4e63ad2965acd31b3">isOrthogonal</a> (matType&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</td></tr>
+<tr class="separator:gab2cb5d23df77b4e4e63ad2965acd31b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p>Decomposes a model matrix to translations, rotation and scale components. </p>
-<p>&lt;glm/gtx/decomposition.hpp&gt; need to be included to use these functionalities. </p>
+<p>Query to evaluate matrix properties. </p>
+<p>&lt;<a class="el" href="a00069.html" title="GLM_GTX_matrix_query ">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="ga0f1245817507156b337798a253577c8b"></a>
+<a class="anchor" id="gafc1ce12c738b8c5d007179e615609330"></a>
 <div class="memitem">
 <div class="memproto">
      <table class="memname">
        <tr>
-          <td class="memname">GLM_FUNC_DECL bool glm::decompose </td>
+          <td class="memname">GLM_FUNC_DECL bool glm::isIdentity </td>
          <td>(</td>
-          <td class="paramtype">tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
-          <td class="paramname"><em>modelMatrix</em>, </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">tvec3&lt; T, P &gt; &amp;&#160;</td>
-          <td class="paramname"><em>scale</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">tquat&lt; T, P &gt; &amp;&#160;</td>
-          <td class="paramname"><em>orientation</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">tvec3&lt; T, P &gt; &amp;&#160;</td>
-          <td class="paramname"><em>translation</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">tvec3&lt; T, P &gt; &amp;&#160;</td>
-          <td class="paramname"><em>skew</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">tvec4&lt; T, P &gt; &amp;&#160;</td>
-          <td class="paramname"><em>perspective</em>&#160;</td>
+          <td class="paramtype">T const &amp;&#160;</td>
+          <td class="paramname"><em>epsilon</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
@@ -101,8 +98,211 @@ Functions</h2></td></tr>
      </table>
 </div><div class="memdoc">

-<p>Decomposes a model matrix to translations, rotation and scale components. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00208.html" title="Decomposes a model matrix to translations, rotation and scale components. ">GLM_GTX_matrix_decompose</a> </dd></dl>
+<p>Return whether a matrix is an identity matrix. </p>
+<p>From GLM_GTX_matrix_query extension. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga11a8d5cdb36496b85f61e4f5f7f2602c"></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">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 is a normalized matrix. </p>
+<p>From GLM_GTX_matrix_query extension. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga351bcc8d485d329b78cfa875e084964d"></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">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 is a normalized matrix. </p>
+<p>From GLM_GTX_matrix_query extension. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga934b673ec0e16d79eca0ca9dbb5d6d8b"></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">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="ga37e535cbeaea383b8c1247b98875cd4b"></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">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="gac67a5c7e029a84b74b02ac9599b8972d"></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">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="ga326de496972051413c7b44b85fc9cb6e"></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">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="gab2cb5d23df77b4e4e63ad2965acd31b3"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">GLM_FUNC_DECL 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>