Updated API doc
This commit is contained in:
Christophe Riccio
@@ -4,7 +4,7 @@
|
||||
<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.10"/>
|
||||
<title>0.9.9 API documenation: Template types</title>
|
||||
<title>0.9.9 API documenation: GLM_GTC_random</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>
|
||||
@@ -74,15 +74,240 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Template types<div class="ingroups"><a class="el" href="a00158.html">GLM Core</a></div></div> </div>
|
||||
<div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00147.html">Stable extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>The generic template types used as the basis for the core types.
|
||||
<p>Include <<a class="el" href="a00085.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>> to use the features of this extension.
|
||||
<a href="#details">More...</a></p>
|
||||
<p>The generic template types used as the basis for the core types. </p>
|
||||
<p>These types are all templates used to define the actual <a class="el" href="a00159.html">Types</a>. These templetes are implementation details of GLM types and should not be used explicitly. </p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, defaultp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a> (T Radius)</td></tr>
|
||||
<tr class="memdesc:ga7c53b7797f3147af68a11c767679fa3f"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. <a href="a00161.html#ga7c53b7797f3147af68a11c767679fa3f">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7c53b7797f3147af68a11c767679fa3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 2, T, defaultp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a> (T Radius)</td></tr>
|
||||
<tr class="memdesc:ga9dd05c36025088fae25b97c869e88517"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. <a href="a00161.html#ga9dd05c36025088fae25b97c869e88517">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9dd05c36025088fae25b97c869e88517"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 2, T, defaultp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a> (T Radius)</td></tr>
|
||||
<tr class="memdesc:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. <a href="a00161.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
|
||||
<tr class="memdesc:ga5193a83e49e4fdc5652c084711083574"><td class="mdescLeft"> </td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a gaussian distribution. <a href="a00161.html#ga5193a83e49e4fdc5652c084711083574">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga04e241ab88374a477a2c2ceadd2fa03d">linearRand</a> (genType Min, genType Max)</td></tr>
|
||||
<tr class="memdesc:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="mdescLeft"> </td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00161.html#ga04e241ab88374a477a2c2ceadd2fa03d">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a> (vec< L, T, Q > const &Min, vec< L, T, Q > const &Max)</td></tr>
|
||||
<tr class="memdesc:ga94731130c298a9ff5e5025fdee6d97a0"><td class="mdescLeft"> </td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, defaultp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00161.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a> (T Radius)</td></tr>
|
||||
<tr class="memdesc:ga22f90fcaccdf001c516ca90f6428e138"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. <a href="a00161.html#ga22f90fcaccdf001c516ca90f6428e138">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga22f90fcaccdf001c516ca90f6428e138"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Include <<a class="el" href="a00085.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Generate random number from various distribution methods. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga7c53b7797f3147af68a11c767679fa3f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, defaultp> glm::ballRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T </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 class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9dd05c36025088fae25b97c869e88517"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<2, T, defaultp> glm::circularRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T </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 class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa0b18071f3f97dbf8bcf6f53c6fe5f73"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<2, T, defaultp> glm::diskRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T </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 class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga5193a83e49e4fdc5652c084711083574"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::gaussRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType </td>
|
||||
<td class="paramname"><em>Mean</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType </td>
|
||||
<td class="paramname"><em>Deviation</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 gaussian distribution. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga04e241ab88374a477a2c2ceadd2fa03d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::linearRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType </td>
|
||||
<td class="paramname"><em>Min</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType </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 class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
|
||||
<tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">genType</td><td>Value type. Currently supported: float or double scalars. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga94731130c298a9ff5e5025fdee6d97a0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::linearRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>Min</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, Q > 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 class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
|
||||
<tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">T</td><td>Value type. Currently supported: float or double.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga22f90fcaccdf001c516ca90f6428e138"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, defaultp> glm::sphericalRand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T </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 on a sphere of a given radius. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00161.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user