mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygem documentation

Browse Source
This commit is contained in:
Christophe Riccio
2014-01-11 23:35:39 +01:00
parent 6335627796
commit cfbd6e43b2
166 changed files with 4147 additions and 3981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
doc/api/a00235.html
View File

@@ -47,52 +47,49 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5988c0d52c89370fcc3fee4eaf0a2dd8"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga5988c0d52c89370fcc3fee4eaf0a2dd8"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga5988c0d52c89370fcc3fee4eaf0a2dd8">areCollinear</a> (genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</td></tr>
<tr class="separator:ga5988c0d52c89370fcc3fee4eaf0a2dd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac9743adb82a3a94693b1693092ae7dca"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac9743adb82a3a94693b1693092ae7dca"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#gac9743adb82a3a94693b1693092ae7dca">areOrthogonal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</td></tr>
<tr class="separator:gac9743adb82a3a94693b1693092ae7dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3fd2c8a48c2d9d3e208bdfed6aafca6e"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga3fd2c8a48c2d9d3e208bdfed6aafca6e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga3fd2c8a48c2d9d3e208bdfed6aafca6e">areOrthonormal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</td></tr>
<tr class="separator:ga3fd2c8a48c2d9d3e208bdfed6aafca6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga441cc2462f1e16aa308d93c68dedcdc9"><td class="memTemplParams" colspan="2">template&lt;typename genType , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga441cc2462f1e16aa308d93c68dedcdc9"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga441cc2462f1e16aa308d93c68dedcdc9">isNormalized</a> (vecType&lt; genType, P &gt; const &amp;v, genType const &amp;epsilon)</td></tr>
<tr class="separator:ga441cc2462f1e16aa308d93c68dedcdc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f98ba431dea5ba29f59d13fe9c66da9"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga5f98ba431dea5ba29f59d13fe9c66da9"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga5f98ba431dea5ba29f59d13fe9c66da9">isNull</a> (detail::tvec2&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga5f98ba431dea5ba29f59d13fe9c66da9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fffb393d1fbf9ed92a78707bff5a3dc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga5fffb393d1fbf9ed92a78707bff5a3dc"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga5fffb393d1fbf9ed92a78707bff5a3dc">isNull</a> (detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga5fffb393d1fbf9ed92a78707bff5a3dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bdf07b9a47cdeb584998c06d5cd53c2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga9bdf07b9a47cdeb584998c06d5cd53c2"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00235.html#ga9bdf07b9a47cdeb584998c06d5cd53c2">isNull</a> (detail::tvec4&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:ga9bdf07b9a47cdeb584998c06d5cd53c2"><td class="memSeparator" colspan="2">&#160;</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>
</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>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga5988c0d52c89370fcc3fee4eaf0a2dd8"></a>
<a class="anchor" id="ga4d8f51cd35294c694bbe8dec1bec03d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areCollinear </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</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">genType const &amp;&#160;</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">typename genType::T const &amp;&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
@@ -108,26 +105,26 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gac9743adb82a3a94693b1693092ae7dca"></a>
<a class="anchor" id="ga671834ed100b138c176f3d91dd080c34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areOrthogonal </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</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">genType const &amp;&#160;</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">typename genType::T const &amp;&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
@@ -143,26 +140,26 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga3fd2c8a48c2d9d3e208bdfed6aafca6e"></a>
<a class="anchor" id="ga05ced31444ad895682e811fcc94f35bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::areOrthonormal </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</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">genType const &amp;&#160;</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">typename genType::T const &amp;&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
@@ -178,20 +175,49 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga441cc2462f1e16aa308d93c68dedcdc9"></a>
<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; genType, P &gt; const &amp;&#160;</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">genType const &amp;&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
@@ -207,72 +233,14 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga5f98ba431dea5ba29f59d13fe9c66da9"></a>
<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">detail::tvec2&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>
<a class="anchor" id="ga5fffb393d1fbf9ed92a78707bff5a3dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNull </td>
<td>(</td>
<td class="paramtype">detail::tvec3&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>
<a class="anchor" id="ga9bdf07b9a47cdeb584998c06d5cd53c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::isNull </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>