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>GLM_GTC_random: Random number generation</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,34 +46,31 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTC_random: Random number generation</h1> </div>
<div class="title">GLM_GTC_random: Random number generation</div> </div>
<div class="ingroups"><a class="el" href="a00151.html">GTC Extensions (Stable)</a></div></div>
<div class="contents">
<p>Generate random number from various distribution methods.
<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 T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gac8ffc47b1c6412c9038a016503ebab3a">ballRand</a> (T const &amp;Radius)</td></tr>
detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga9603f085f45198fac365d85756941be5">ballRand</a> (T const &amp;Radius)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga4d5cb7d616c5e6a86cd67596c4ecdce7">circularRand</a> (T const &amp;Radius)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga6e74477d1997a1bc2cf62bcc36167674">circularRand</a> (T const &amp;Radius)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gac41789a5e18b0e348e16682f6fd08030">diskRand</a> (T const &amp;Radius)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#gaacf5ed0c8f984b4ca3004019c573dc51">diskRand</a> (T const &amp;Radius)</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="a00165.html#gac3fa11c5d19f372d27723c3740cb3c48">gaussRand</a> (genType const &amp;Mean, genType const &amp;Deviation)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga8cf40a2f2268b91103f763b6ea2c44d8">gaussRand</a> (genType const &amp;Mean, genType const &amp;Deviation)</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="a00165.html#gaee431f5ec7235df13149ec6d6a50d8ce">linearRand</a> (genType const &amp;Min, genType const &amp;Max)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga4fbce21c9727ffcd7f19813d6d7d8024">linearRand</a> (genType const &amp;Min, genType const &amp;Max)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga861430313755eae62d924c84395401f5">sphericalRand</a> (T const &amp;Radius)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00165.html#ga291f75129653fa6371d2d57d78f8aca6">sphericalRand</a> (T const &amp;Radius)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Generate random number from various distribution methods. </p>
<p>&lt;<a class="el" href="a00093.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gac8ffc47b1c6412c9038a016503ebab3a"></a><!-- doxytag: member="glm::ballRand" ref="gac8ffc47b1c6412c9038a016503ebab3a" args="(T const &amp;Radius)" -->
<a class="anchor" id="ga9603f085f45198fac365d85756941be5"></a><!-- doxytag: member="glm::ballRand" ref="ga9603f085f45198fac365d85756941be5" args="(T const &amp;Radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -85,7 +96,7 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="ga4d5cb7d616c5e6a86cd67596c4ecdce7"></a><!-- doxytag: member="glm::circularRand" ref="ga4d5cb7d616c5e6a86cd67596c4ecdce7" args="(T const &amp;Radius)" -->
<a class="anchor" id="ga6e74477d1997a1bc2cf62bcc36167674"></a><!-- doxytag: member="glm::circularRand" ref="ga6e74477d1997a1bc2cf62bcc36167674" args="(T const &amp;Radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -111,7 +122,7 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="gac41789a5e18b0e348e16682f6fd08030"></a><!-- doxytag: member="glm::diskRand" ref="gac41789a5e18b0e348e16682f6fd08030" args="(T const &amp;Radius)" -->
<a class="anchor" id="gaacf5ed0c8f984b4ca3004019c573dc51"></a><!-- doxytag: member="glm::diskRand" ref="gaacf5ed0c8f984b4ca3004019c573dc51" args="(T const &amp;Radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -137,7 +148,7 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="gac3fa11c5d19f372d27723c3740cb3c48"></a><!-- doxytag: member="glm::gaussRand" ref="gac3fa11c5d19f372d27723c3740cb3c48" args="(genType const &amp;Mean, genType const &amp;Deviation)" -->
<a class="anchor" id="ga8cf40a2f2268b91103f763b6ea2c44d8"></a><!-- doxytag: member="glm::gaussRand" ref="ga8cf40a2f2268b91103f763b6ea2c44d8" args="(genType const &amp;Mean, genType const &amp;Deviation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -174,7 +185,7 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="gaee431f5ec7235df13149ec6d6a50d8ce"></a><!-- doxytag: member="glm::linearRand" ref="gaee431f5ec7235df13149ec6d6a50d8ce" args="(genType const &amp;Min, genType const &amp;Max)" -->
<a class="anchor" id="ga4fbce21c9727ffcd7f19813d6d7d8024"></a><!-- doxytag: member="glm::linearRand" ref="ga4fbce21c9727ffcd7f19813d6d7d8024" args="(genType const &amp;Min, genType const &amp;Max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -217,7 +228,7 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="ga861430313755eae62d924c84395401f5"></a><!-- doxytag: member="glm::sphericalRand" ref="ga861430313755eae62d924c84395401f5" args="(T const &amp;Radius)" -->
<a class="anchor" id="ga291f75129653fa6371d2d57d78f8aca6"></a><!-- doxytag: member="glm::sphericalRand" ref="ga291f75129653fa6371d2d57d78f8aca6" args="(T const &amp;Radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -244,8 +255,13 @@ detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</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>