Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Geometric functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,36 +46,33 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Geometric functions</h1> </div>
<div class="title">Geometric functions</div> </div>
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<p>These operate on vectors as vectors, not component-wise.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gaf2c23b0c90b3569b2c9a3e4e0ada4cd4">cross</a> (detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gaa127ddc9d38f715125f91742d399eb6f">cross</a> (detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gad8e0b5e88b74b373c2820142ad2b4103">distance</a> (genType const &amp;p0, genType const &amp;p1)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga3fac0e61144f60184d961dd156709dd3">distance</a> (genType const &amp;p0, genType const &amp;p1)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gaf7ca312d4c8949ecfe9615d9777aa242">dot</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga7a31d2864eccfe665409e3b44f5e6e8d">dot</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gafbf77dccfcfedf5dd480771c6794e27b">faceforward</a> (genType const &amp;N, genType const &amp;I, genType const &amp;Nref)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga855fc5fd7779df1683482564956c6764">faceforward</a> (genType const &amp;N, genType const &amp;I, genType const &amp;Nref)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga60de55d549a96b9303730a10173e6fa3">length</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga282360c8bb80b80d3c7f5bc00766d873">length</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gabbb9186ee077ee7664dc51d05df3f43d">normalize</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga68b931c228750eeba844c273c54ca43d">normalize</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#ga8db5042950e76a6fcb5bbddfbd1d254d">reflect</a> (genType const &amp;I, genType const &amp;N)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gabe1fa0bef5f854242eb70ce56e5a7d03">reflect</a> (genType const &amp;I, genType const &amp;N)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gacda8041bcba8c9698a799c911c7fefdf">refract</a> (genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00144.html#gabbb4909d3e99a7a2411cc63252afbbd8">refract</a> (genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>These operate on vectors as vectors, not component-wise. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaf2c23b0c90b3569b2c9a3e4e0ada4cd4"></a><!-- doxytag: member="glm::cross" ref="gaf2c23b0c90b3569b2c9a3e4e0ada4cd4" args="(detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)" -->
<a class="anchor" id="gaa127ddc9d38f715125f91742d399eb6f"></a><!-- doxytag: member="glm::cross" ref="gaa127ddc9d38f715125f91742d399eb6f" args="(detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -99,7 +110,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gad8e0b5e88b74b373c2820142ad2b4103"></a><!-- doxytag: member="glm::distance" ref="gad8e0b5e88b74b373c2820142ad2b4103" args="(genType const &amp;p0, genType const &amp;p1)" -->
<a class="anchor" id="ga3fac0e61144f60184d961dd156709dd3"></a><!-- doxytag: member="glm::distance" ref="ga3fac0e61144f60184d961dd156709dd3" args="(genType const &amp;p0, genType const &amp;p1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -137,7 +148,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaf7ca312d4c8949ecfe9615d9777aa242"></a><!-- doxytag: member="glm::dot" ref="gaf7ca312d4c8949ecfe9615d9777aa242" args="(genType const &amp;x, genType const &amp;y)" -->
<a class="anchor" id="ga7a31d2864eccfe665409e3b44f5e6e8d"></a><!-- doxytag: member="glm::dot" ref="ga7a31d2864eccfe665409e3b44f5e6e8d" args="(genType const &amp;x, genType const &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -175,7 +186,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gafbf77dccfcfedf5dd480771c6794e27b"></a><!-- doxytag: member="glm::faceforward" ref="gafbf77dccfcfedf5dd480771c6794e27b" args="(genType const &amp;N, genType const &amp;I, genType const &amp;Nref)" -->
<a class="anchor" id="ga855fc5fd7779df1683482564956c6764"></a><!-- doxytag: member="glm::faceforward" ref="ga855fc5fd7779df1683482564956c6764" args="(genType const &amp;N, genType const &amp;I, genType const &amp;Nref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -219,7 +230,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga60de55d549a96b9303730a10173e6fa3"></a><!-- doxytag: member="glm::length" ref="ga60de55d549a96b9303730a10173e6fa3" args="(genType const &amp;x)" -->
<a class="anchor" id="ga282360c8bb80b80d3c7f5bc00766d873"></a><!-- doxytag: member="glm::length" ref="ga282360c8bb80b80d3c7f5bc00766d873" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -247,7 +258,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gabbb9186ee077ee7664dc51d05df3f43d"></a><!-- doxytag: member="glm::normalize" ref="gabbb9186ee077ee7664dc51d05df3f43d" args="(genType const &amp;x)" -->
<a class="anchor" id="ga68b931c228750eeba844c273c54ca43d"></a><!-- doxytag: member="glm::normalize" ref="ga68b931c228750eeba844c273c54ca43d" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -269,7 +280,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga8db5042950e76a6fcb5bbddfbd1d254d"></a><!-- doxytag: member="glm::reflect" ref="ga8db5042950e76a6fcb5bbddfbd1d254d" args="(genType const &amp;I, genType const &amp;N)" -->
<a class="anchor" id="gabe1fa0bef5f854242eb70ce56e5a7d03"></a><!-- doxytag: member="glm::reflect" ref="gabe1fa0bef5f854242eb70ce56e5a7d03" args="(genType const &amp;I, genType const &amp;N)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -307,7 +318,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gacda8041bcba8c9698a799c911c7fefdf"></a><!-- doxytag: member="glm::refract" ref="gacda8041bcba8c9698a799c911c7fefdf" args="(genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)" -->
<a class="anchor" id="gabbb4909d3e99a7a2411cc63252afbbd8"></a><!-- doxytag: member="glm::refract" ref="gabbb4909d3e99a7a2411cc63252afbbd8" args="(genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -352,8 +363,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<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.7.3 </small></address>
<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.7.5
</small></address>
</body>
</html>