Updated API doc
This commit is contained in:
Christophe Riccio
@@ -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: GLM_GTX_matrix_query</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_range</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>
|
||||
@@ -74,287 +74,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_matrix_query<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_range<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Query to evaluate matrix properties.
|
||||
<p>Include <<a class="el" href="a00086.html" title="GLM_GTX_range ">glm/gtx/range.hpp</a>> to use the features of this extension.
|
||||
<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:ga9d001ed94dc7563cfc0af4608d04a2b6"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier P, template< length_t, length_t, typename, qualifier > class matType> </td></tr>
|
||||
<tr class="memitem:ga9d001ed94dc7563cfc0af4608d04a2b6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga9d001ed94dc7563cfc0af4608d04a2b6">isIdentity</a> (matType< C, R, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga9d001ed94dc7563cfc0af4608d04a2b6"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is an identity matrix. <a href="a00213.html#ga9d001ed94dc7563cfc0af4608d04a2b6">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9d001ed94dc7563cfc0af4608d04a2b6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7b5bd79dd0810895ed617603eabc12f2"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga7b5bd79dd0810895ed617603eabc12f2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga7b5bd79dd0810895ed617603eabc12f2">isNormalized</a> (mat< 2, 2, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga7b5bd79dd0810895ed617603eabc12f2"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is a normalized matrix. <a href="a00213.html#ga7b5bd79dd0810895ed617603eabc12f2">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7b5bd79dd0810895ed617603eabc12f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga6677b3786936523db58eae6abc970f4c"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga6677b3786936523db58eae6abc970f4c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga6677b3786936523db58eae6abc970f4c">isNormalized</a> (mat< 3, 3, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga6677b3786936523db58eae6abc970f4c"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is a normalized matrix. <a href="a00213.html#ga6677b3786936523db58eae6abc970f4c">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga6677b3786936523db58eae6abc970f4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga77a72258482086749af8ce72de8b8c57"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga77a72258482086749af8ce72de8b8c57"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga77a72258482086749af8ce72de8b8c57">isNormalized</a> (mat< 4, 4, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga77a72258482086749af8ce72de8b8c57"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is a normalized matrix. <a href="a00213.html#ga77a72258482086749af8ce72de8b8c57">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga77a72258482086749af8ce72de8b8c57"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2b06d76b4dbd06913ef2fb2aef96b975"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga2b06d76b4dbd06913ef2fb2aef96b975"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga2b06d76b4dbd06913ef2fb2aef96b975">isNull</a> (mat< 2, 2, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga2b06d76b4dbd06913ef2fb2aef96b975"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix a null matrix. <a href="a00213.html#ga2b06d76b4dbd06913ef2fb2aef96b975">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2b06d76b4dbd06913ef2fb2aef96b975"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae9ae6d81a10d126f7974a41c0f806073"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gae9ae6d81a10d126f7974a41c0f806073"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gae9ae6d81a10d126f7974a41c0f806073">isNull</a> (mat< 3, 3, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gae9ae6d81a10d126f7974a41c0f806073"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix a null matrix. <a href="a00213.html#gae9ae6d81a10d126f7974a41c0f806073">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae9ae6d81a10d126f7974a41c0f806073"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga72a53937c4aef5ad895456abae806f55"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga72a53937c4aef5ad895456abae806f55"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga72a53937c4aef5ad895456abae806f55">isNull</a> (mat< 4, 4, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga72a53937c4aef5ad895456abae806f55"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is a null matrix. <a href="a00213.html#ga72a53937c4aef5ad895456abae806f55">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga72a53937c4aef5ad895456abae806f55"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa035a00c0a5d72b77bd1b558ccb75278"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier P, template< length_t, length_t, typename, qualifier > class matType> </td></tr>
|
||||
<tr class="memitem:gaa035a00c0a5d72b77bd1b558ccb75278"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gaa035a00c0a5d72b77bd1b558ccb75278">isOrthogonal</a> (matType< C, R, T, P > const &m, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gaa035a00c0a5d72b77bd1b558ccb75278"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a matrix is an orthonormalized matrix. <a href="a00213.html#gaa035a00c0a5d72b77bd1b558ccb75278">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa035a00c0a5d72b77bd1b558ccb75278"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Query to evaluate matrix properties. </p>
|
||||
<p><<a class="el" href="a00073.html" title="GLM_GTX_matrix_query ">glm/gtx/matrix_query.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga9d001ed94dc7563cfc0af4608d04a2b6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL bool glm::isIdentity </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">matType< C, R, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return whether a matrix is an identity matrix. </p>
|
||||
<p>From GLM_GTX_matrix_query extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga7b5bd79dd0810895ed617603eabc12f2"></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">mat< 2, 2, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="ga6677b3786936523db58eae6abc970f4c"></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">mat< 3, 3, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="ga77a72258482086749af8ce72de8b8c57"></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">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="ga2b06d76b4dbd06913ef2fb2aef96b975"></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">mat< 2, 2, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="gae9ae6d81a10d126f7974a41c0f806073"></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">mat< 3, 3, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="ga72a53937c4aef5ad895456abae806f55"></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">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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="gaa035a00c0a5d72b77bd1b558ccb75278"></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< C, R, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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>
|
||||
<p>Include <<a class="el" href="a00086.html" title="GLM_GTX_range ">glm/gtx/range.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Defines begin and end for vectors and matrices. Useful for range-based for loop. The range is defined over the elements, not over columns or rows (e.g. mat4 has 16 elements). </p>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user