mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen for 0.9.6 API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
doc/api/a00235.html
View File

@@ -3,8 +3,8 @@
<head>
<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.5"/>
<title>GLM: GLM_GTX_vector_query</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: GLM_GTX_transform</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>
@@ -16,9 +16,9 @@
<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 id="projectname">0.9.6
</div>
</td>
</tr>
@@ -26,13 +26,11 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<!-- Generated by Doxygen 1.8.8 -->
<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>
@@ -41,56 +39,41 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_vector_query<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_transform<div class="ingroups"><a class="el" href="a00160.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:ga4d8f51cd35294c694bbe8dec1bec03d8"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga4d8f51cd35294c694bbe8dec1bec03d8"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga4d8f51cd35294c694bbe8dec1bec03d8">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="separator:ga4d8f51cd35294c694bbe8dec1bec03d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga671834ed100b138c176f3d91dd080c34"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga671834ed100b138c176f3d91dd080c34"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga671834ed100b138c176f3d91dd080c34">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="separator:ga671834ed100b138c176f3d91dd080c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05ced31444ad895682e811fcc94f35bd"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga05ced31444ad895682e811fcc94f35bd"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga05ced31444ad895682e811fcc94f35bd">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="separator:ga05ced31444ad895682e811fcc94f35bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8281979eb4a14f05c38a1225ea9933ba"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga8281979eb4a14f05c38a1225ea9933ba"><td class="memTemplItemLeft" align="right" valign="top">vecType&lt; bool, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga8281979eb4a14f05c38a1225ea9933ba">isCompNull</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga8281979eb4a14f05c38a1225ea9933ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a2cab7f958252d377133a51469d7126"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga9a2cab7f958252d377133a51469d7126"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga9a2cab7f958252d377133a51469d7126">isNormalized</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga9a2cab7f958252d377133a51469d7126"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ec70fc9a1526725b3427d49db90d8d6"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga6ec70fc9a1526725b3427d49db90d8d6"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga6ec70fc9a1526725b3427d49db90d8d6">isNull</a> (vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga6ec70fc9a1526725b3427d49db90d8d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2020c91bf61e050882b3a5c18eada700"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga2020c91bf61e050882b3a5c18eada700"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga2020c91bf61e050882b3a5c18eada700">rotate</a> (T angle, tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga2020c91bf61e050882b3a5c18eada700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1972d4a66a2e92637c8aaee598417a71"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga1972d4a66a2e92637c8aaee598417a71"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga1972d4a66a2e92637c8aaee598417a71">scale</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga1972d4a66a2e92637c8aaee598417a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga838c4505ef7f254ed05117b1ac9691fb">translate</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Query informations of vector types. </p>
<p>&lt;<a class="el" href="a00147.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/vector_query.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Add transformation matrices. </p>
<p>&lt;<a class="el" href="a00112.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/transform.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4d8f51cd35294c694bbe8dec1bec03d8"></a>
<a class="anchor" id="ga2020c91bf61e050882b3a5c18eada700"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areCollinear </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>angle</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>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -100,165 +83,52 @@ Functions</h2></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>
<p>Builds a rotation 4 * 4 matrix created from an axis of 3 scalars and an angle expressed in degrees. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00235.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga671834ed100b138c176f3d91dd080c34"></a>
<a class="anchor" id="ga1972d4a66a2e92637c8aaee598417a71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areOrthogonal </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::scale </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 class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</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>
<p>Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00235.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga05ced31444ad895682e811fcc94f35bd"></a>
<a class="anchor" id="ga838c4505ef7f254ed05117b1ac9691fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areOrthonormal </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::translate </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 class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</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="ga8281979eb4a14f05c38a1225ea9933ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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="ga9a2cab7f958252d377133a51469d7126"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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="ga6ec70fc9a1526725b3427d49db90d8d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<p>Transforms a matrix with a translation 4 * 4 matrix created from 3 scalars. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00235.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>
@@ -267,7 +137,7 @@ Functions</h2></td></tr>
<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.5
</a> 1.8.8
</small></address>
</body>
</html>