Updated documentation
This commit is contained in:
Christophe Riccio
@@ -2,266 +2,125 @@
|
||||
<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>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>GLM_GTC_matrix_inverse</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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<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.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTC_random: Random number generation</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00136.html">GTC Extensions (Stable)</a></div></div>
|
||||
<div class="title">GLM_GTC_matrix_inverse</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00138.html">GTC Extensions (Stable)</a></div></div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
|
||||
detail::tvec3< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga9603f085f45198fac365d85756941be5">ballRand</a> (T const &Radius)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga6e74477d1997a1bc2cf62bcc36167674">circularRand</a> (T const &Radius)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaacf5ed0c8f984b4ca3004019c573dc51">diskRand</a> (T const &Radius)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga8cf40a2f2268b91103f763b6ea2c44d8">gaussRand</a> (genType const &Mean, genType const &Deviation)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga4fbce21c9727ffcd7f19813d6d7d8024">linearRand</a> (genType const &Min, genType const &Max)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga291f75129653fa6371d2d57d78f8aca6">sphericalRand</a> (T const &Radius)</td></tr>
|
||||
<tr class="memitem:ga644904b05dab519821fdaaa643ac9c0c"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga644904b05dab519821fdaaa643ac9c0c"><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga644904b05dab519821fdaaa643ac9c0c">affineInverse</a> (genType const &m)</td></tr>
|
||||
<tr class="separator:ga644904b05dab519821fdaaa643ac9c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5fd97e07f032af2b5a4698b6bf0b9ecc"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga5fd97e07f032af2b5a4698b6bf0b9ecc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
|
||||
genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga5fd97e07f032af2b5a4698b6bf0b9ecc">inverseTranspose</a> (genType const &m)</td></tr>
|
||||
<tr class="separator:ga5fd97e07f032af2b5a4698b6bf0b9ecc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Generate random number from various distribution methods. </p>
|
||||
<p><<a class="el" href="a00078.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/random.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="ga9603f085f45198fac365d85756941be5"></a><!-- doxytag: member="glm::ballRand" ref="ga9603f085f45198fac365d85756941be5" args="(T const &Radius)" -->
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Defines additional matrix inverting functions. </p>
|
||||
<p><<a class="el" href="a00056.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/matrix_inverse.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga644904b05dab519821fdaaa643ac9c0c"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER detail::tvec3<T> glm::ballRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>Radius</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Radius</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga6e74477d1997a1bc2cf62bcc36167674"></a><!-- doxytag: member="glm::circularRand" ref="ga6e74477d1997a1bc2cf62bcc36167674" args="(T const &Radius)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec2<T> glm::circularRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>Radius</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Radius</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaacf5ed0c8f984b4ca3004019c573dc51"></a><!-- doxytag: member="glm::diskRand" ref="gaacf5ed0c8f984b4ca3004019c573dc51" args="(T const &Radius)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec2<T> glm::diskRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>Radius</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Radius</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8cf40a2f2268b91103f763b6ea2c44d8"></a><!-- doxytag: member="glm::gaussRand" ref="ga8cf40a2f2268b91103f763b6ea2c44d8" args="(genType const &Mean, genType const &Deviation)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType glm::gaussRand </td>
|
||||
<td class="memname">genType glm::affineInverse </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Mean</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramname"><em>m</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Deviation</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<p>Fast matrix inverse for affine matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Mean</td><td></td></tr>
|
||||
<tr><td class="paramname">Deviation</td><td></td></tr>
|
||||
<tr><td class="paramname">m</td><td>Input matrix to invert. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">genType</td><td>Squared floating-point matrix: half, float or double. Inverse of matrix based of half-precision floating point value is highly innacurate. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00150.html" title="Defines additional matrix inverting functions.">GLM_GTC_matrix_inverse</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga4fbce21c9727ffcd7f19813d6d7d8024"></a><!-- doxytag: member="glm::linearRand" ref="ga4fbce21c9727ffcd7f19813d6d7d8024" args="(genType const &Min, genType const &Max)" -->
|
||||
<a class="anchor" id="ga5fd97e07f032af2b5a4698b6bf0b9ecc"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType glm::linearRand </td>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER genType::value_type glm::inverseTranspose </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Min</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Max</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Min</td><td></td></tr>
|
||||
<tr><td class="paramname">Max</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl><dt><b>Template Parameters:</b></dt><dd>
|
||||
<table class="">
|
||||
<tr><td class="paramname">genType</td><td>Value type. Currently supported: half (not recommanded), float or double scalars and vectors. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga291f75129653fa6371d2d57d78f8aca6"></a><!-- doxytag: member="glm::sphericalRand" ref="ga291f75129653fa6371d2d57d78f8aca6" args="(T const &Radius)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec3<T> glm::sphericalRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>Radius</em></td><td>)</td>
|
||||
<td class="paramname"><em>m</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
|
||||
<dl><dt><b>Parameters:</b></dt><dd>
|
||||
<p>Compute the inverse transpose of a matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Radius</td><td></td></tr>
|
||||
<tr><td class="paramname">m</td><td>Input matrix to invert transpose. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">genType</td><td>Squared floating-point matrix: half, float or double. Inverse of matrix based of half-precision floating point value is highly innacurate. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00150.html" title="Defines additional matrix inverting functions.">GLM_GTC_matrix_inverse</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user