mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
This commit is contained in:
Christophe Riccio
2018-09-02 23:34:18 +02:00
parent 49b508a1ab
commit 0c2e470baf
1013 changed files with 94654 additions and 80816 deletions
Download Patch File Download Diff File Expand all files Collapse all files

299
doc/api/a00167.html
View File

@@ -3,17 +3,15 @@
<head>
<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: GLM_GTC_random</title>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>0.9.9 API documenation: matrix_float3x3_precision.hpp File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -32,34 +30,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -74,247 +60,46 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_02cc19cee4c4780485bfe81520450212.html">christophericcio</a></li><li class="navelem"><a class="el" href="dir_54de7df3bc9880881b14ec07f256fd2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_6399a054f5929b58eaa476233e406ce8.html">Repository</a></li><li class="navelem"><a class="el" href="dir_627f4a52155b61a75c7c4851d7df9027.html">Github</a></li><li class="navelem"><a class="el" href="dir_ffdfd01cf51cdb2fe8bd5e55c6e0c4e8.html">glm</a></li><li class="navelem"><a class="el" href="dir_4ca6aa55b50e6be994025af27820140e.html">glm</a></li><li class="navelem"><a class="el" href="dir_b115b02f1dab989141fcd87ab0462f01.html">ext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00153.html">Recommended extensions</a></div></div> </div>
<div class="title">matrix_float3x3_precision.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Include &lt;<a class="el" href="a00085.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<p><a href="a00167_source.html">Go to the source code of this file.</a></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&lt;typename T &gt; </td></tr>
<tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a> (T Radius)</td></tr>
<tr class="memdesc:ga7c53b7797f3147af68a11c767679fa3f"><td class="mdescLeft">&#160;</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="a00167.html#ga7c53b7797f3147af68a11c767679fa3f">More...</a><br /></td></tr>
<tr class="separator:ga7c53b7797f3147af68a11c767679fa3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a> (T Radius)</td></tr>
<tr class="memdesc:ga9dd05c36025088fae25b97c869e88517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. <a href="a00167.html#ga9dd05c36025088fae25b97c869e88517">More...</a><br /></td></tr>
<tr class="separator:ga9dd05c36025088fae25b97c869e88517"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a> (T Radius)</td></tr>
<tr class="memdesc:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="mdescLeft">&#160;</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="a00167.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">More...</a><br /></td></tr>
<tr class="separator:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
<tr class="memdesc:ga5193a83e49e4fdc5652c084711083574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a gaussian distribution. <a href="a00167.html#ga5193a83e49e4fdc5652c084711083574">More...</a><br /></td></tr>
<tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga04e241ab88374a477a2c2ceadd2fa03d">linearRand</a> (genType Min, genType Max)</td></tr>
<tr class="memdesc:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00167.html#ga04e241ab88374a477a2c2ceadd2fa03d">More...</a><br /></td></tr>
<tr class="separator:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a> (vec&lt; L, T, Q &gt; const &amp;Min, vec&lt; L, T, Q &gt; const &amp;Max)</td></tr>
<tr class="memdesc:ga94731130c298a9ff5e5025fdee6d97a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">More...</a><br /></td></tr>
<tr class="separator:ga94731130c298a9ff5e5025fdee6d97a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a> (T Radius)</td></tr>
<tr class="memdesc:ga22f90fcaccdf001c516ca90f6428e138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. <a href="a00167.html#ga22f90fcaccdf001c516ca90f6428e138">More...</a><br /></td></tr>
<tr class="separator:ga22f90fcaccdf001c516ca90f6428e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga3fd9849f3da5ed6e3decc3fb10a20b3e"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, highp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#ga3fd9849f3da5ed6e3decc3fb10a20b3e">highp_mat3</a></td></tr>
<tr class="separator:ga3fd9849f3da5ed6e3decc3fb10a20b3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ea82e12f4d7afcfce8f59894d400230"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, highp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#ga2ea82e12f4d7afcfce8f59894d400230">highp_mat3x3</a></td></tr>
<tr class="separator:ga2ea82e12f4d7afcfce8f59894d400230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6271ebc85ed778ccc15458c3d86fc854"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, lowp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#ga6271ebc85ed778ccc15458c3d86fc854">lowp_mat3</a></td></tr>
<tr class="separator:ga6271ebc85ed778ccc15458c3d86fc854"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63362cb4a63fc1be7d2e49cd5d574c84"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, lowp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#ga63362cb4a63fc1be7d2e49cd5d574c84">lowp_mat3x3</a></td></tr>
<tr class="separator:ga63362cb4a63fc1be7d2e49cd5d574c84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5aae49834d02732942f44e61d7bce136"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, mediump &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#ga5aae49834d02732942f44e61d7bce136">mediump_mat3</a></td></tr>
<tr class="separator:ga5aae49834d02732942f44e61d7bce136"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc0f2f4ad21c90b341881cf056f8650e"><td class="memItemLeft" align="right" valign="top">typedef mat&lt; 3, 3, float, mediump &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00702.html#gabc0f2f4ad21c90b341881cf056f8650e">mediump_mat3x3</a></td></tr>
<tr class="separator:gabc0f2f4ad21c90b341881cf056f8650e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;<a class="el" href="a00085.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>&gt; 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&lt;3, T, defaultp&gt; glm::ballRand </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>Radius</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p><a class="el" href="a00698.html">Core features</a> </p>
<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="a00167.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&lt;2, T, defaultp&gt; glm::circularRand </td>
<td>(</td>
<td class="paramtype">T&#160;</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="a00167.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&lt;2, T, defaultp&gt; glm::diskRand </td>
<td>(</td>
<td class="paramtype">T&#160;</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="a00167.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&#160;</td>
<td class="paramname"><em>Mean</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Deviation</em>&#160;</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="a00167.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&#160;</td>
<td class="paramname"><em>Min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Max</em>&#160;</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="a00167.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&lt;L, T, Q&gt; glm::linearRand </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Max</em>&#160;</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="a00167.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&lt;3, T, defaultp&gt; glm::sphericalRand </td>
<td>(</td>
<td class="paramtype">T&#160;</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="a00167.html" title="Include <glm/gtc/random.hpp> to use the features of this extension. ">GLM_GTC_random</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<p class="definition">Definition in file <a class="el" href="a00167_source.html">matrix_float3x3_precision.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<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.8.10
</a> 1.8.14
</small></address>
</body>
</html>