a00173.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.9 API documenation: GLM_GTC_random</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documenation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00153.html">GTC Extensions (Stable)</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Generate random number from various distribution methods.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <tr class="memitem:ga5506dee301160e3a06aef9b9bc7a0a83"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  88. <tr class="memitem:ga5506dee301160e3a06aef9b9bc7a0a83"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga5506dee301160e3a06aef9b9bc7a0a83">ballRand</a> (T Radius)</td></tr>
  89. <tr class="memdesc:ga5506dee301160e3a06aef9b9bc7a0a83"><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="a00173.html#ga5506dee301160e3a06aef9b9bc7a0a83">More...</a><br /></td></tr>
  90. <tr class="separator:ga5506dee301160e3a06aef9b9bc7a0a83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gae989c26a2899b2fb7444abe7c275c29c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  92. <tr class="memitem:gae989c26a2899b2fb7444abe7c275c29c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gae989c26a2899b2fb7444abe7c275c29c">circularRand</a> (T Radius)</td></tr>
  93. <tr class="memdesc:gae989c26a2899b2fb7444abe7c275c29c"><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="a00173.html#gae989c26a2899b2fb7444abe7c275c29c">More...</a><br /></td></tr>
  94. <tr class="separator:gae989c26a2899b2fb7444abe7c275c29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:gad3a3ee7d26502a31ba552cb627a68606"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  96. <tr class="memitem:gad3a3ee7d26502a31ba552cb627a68606"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gad3a3ee7d26502a31ba552cb627a68606">diskRand</a> (T Radius)</td></tr>
  97. <tr class="memdesc:gad3a3ee7d26502a31ba552cb627a68606"><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="a00173.html#gad3a3ee7d26502a31ba552cb627a68606">More...</a><br /></td></tr>
  98. <tr class="separator:gad3a3ee7d26502a31ba552cb627a68606"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  100. <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="a00173.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
  101. <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="a00173.html#ga5193a83e49e4fdc5652c084711083574">More...</a><br /></td></tr>
  102. <tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="memTemplParams" colspan="2">template&lt;typename genTYpe &gt; </td></tr>
  104. <tr class="memitem:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genTYpe&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga12aebc19b85a8c736f5801c2f7b9b716">linearRand</a> (genTYpe Min, genTYpe Max)</td></tr>
  105. <tr class="memdesc:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00173.html#ga12aebc19b85a8c736f5801c2f7b9b716">More...</a><br /></td></tr>
  106. <tr class="separator:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:gaba9cec867916d894d794a32897b7fdfd"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  108. <tr class="memitem:gaba9cec867916d894d794a32897b7fdfd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaba9cec867916d894d794a32897b7fdfd">linearRand</a> (vecType&lt; T, P &gt; const &amp;Min, vecType&lt; T, P &gt; const &amp;Max)</td></tr>
  109. <tr class="memdesc:gaba9cec867916d894d794a32897b7fdfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00173.html#gaba9cec867916d894d794a32897b7fdfd">More...</a><br /></td></tr>
  110. <tr class="separator:gaba9cec867916d894d794a32897b7fdfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:gaa9a6fc2d7a295b3857f7db23b1053d9d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  112. <tr class="memitem:gaa9a6fc2d7a295b3857f7db23b1053d9d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaa9a6fc2d7a295b3857f7db23b1053d9d">sphericalRand</a> (T Radius)</td></tr>
  113. <tr class="memdesc:gaa9a6fc2d7a295b3857f7db23b1053d9d"><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="a00173.html#gaa9a6fc2d7a295b3857f7db23b1053d9d">More...</a><br /></td></tr>
  114. <tr class="separator:gaa9a6fc2d7a295b3857f7db23b1053d9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  117. <p>Generate random number from various distribution methods. </p>
  118. <p>&lt;<a class="el" href="a00090.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
  119. <h2 class="groupheader">Function Documentation</h2>
  120. <a class="anchor" id="ga5506dee301160e3a06aef9b9bc7a0a83"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">GLM_FUNC_DECL tvec3&lt;T, defaultp&gt; glm::ballRand </td>
  126. <td>(</td>
  127. <td class="paramtype">T&#160;</td>
  128. <td class="paramname"><em>Radius</em></td><td>)</td>
  129. <td></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
  134. <dl class="params"><dt>Parameters</dt><dd>
  135. <table class="params">
  136. <tr><td class="paramname">Radius</td><td></td></tr>
  137. </table>
  138. </dd>
  139. </dl>
  140. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  141. </div>
  142. </div>
  143. <a class="anchor" id="gae989c26a2899b2fb7444abe7c275c29c"></a>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">GLM_FUNC_DECL tvec2&lt;T, defaultp&gt; glm::circularRand </td>
  149. <td>(</td>
  150. <td class="paramtype">T&#160;</td>
  151. <td class="paramname"><em>Radius</em></td><td>)</td>
  152. <td></td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
  157. <dl class="params"><dt>Parameters</dt><dd>
  158. <table class="params">
  159. <tr><td class="paramname">Radius</td><td></td></tr>
  160. </table>
  161. </dd>
  162. </dl>
  163. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  164. </div>
  165. </div>
  166. <a class="anchor" id="gad3a3ee7d26502a31ba552cb627a68606"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">GLM_FUNC_DECL tvec2&lt;T, defaultp&gt; glm::diskRand </td>
  172. <td>(</td>
  173. <td class="paramtype">T&#160;</td>
  174. <td class="paramname"><em>Radius</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">Radius</td><td></td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  187. </div>
  188. </div>
  189. <a class="anchor" id="ga5193a83e49e4fdc5652c084711083574"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">GLM_FUNC_DECL genType glm::gaussRand </td>
  195. <td>(</td>
  196. <td class="paramtype">genType&#160;</td>
  197. <td class="paramname"><em>Mean</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype">genType&#160;</td>
  203. <td class="paramname"><em>Deviation</em>&#160;</td>
  204. </tr>
  205. <tr>
  206. <td></td>
  207. <td>)</td>
  208. <td></td><td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
  213. <dl class="params"><dt>Parameters</dt><dd>
  214. <table class="params">
  215. <tr><td class="paramname">Mean</td><td></td></tr>
  216. <tr><td class="paramname">Deviation</td><td></td></tr>
  217. </table>
  218. </dd>
  219. </dl>
  220. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  221. </div>
  222. </div>
  223. <a class="anchor" id="ga12aebc19b85a8c736f5801c2f7b9b716"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">GLM_FUNC_DECL genTYpe glm::linearRand </td>
  229. <td>(</td>
  230. <td class="paramtype">genTYpe&#160;</td>
  231. <td class="paramname"><em>Min</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">genTYpe&#160;</td>
  237. <td class="paramname"><em>Max</em>&#160;</td>
  238. </tr>
  239. <tr>
  240. <td></td>
  241. <td>)</td>
  242. <td></td><td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  247. <dl class="params"><dt>Parameters</dt><dd>
  248. <table class="params">
  249. <tr><td class="paramname">Min</td><td></td></tr>
  250. <tr><td class="paramname">Max</td><td></td></tr>
  251. </table>
  252. </dd>
  253. </dl>
  254. <dl class="tparams"><dt>Template Parameters</dt><dd>
  255. <table class="tparams">
  256. <tr><td class="paramname">genType</td><td>Value type. Currently supported: float or double scalars. </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  261. </div>
  262. </div>
  263. <a class="anchor" id="gaba9cec867916d894d794a32897b7fdfd"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::linearRand </td>
  269. <td>(</td>
  270. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  271. <td class="paramname"><em>Min</em>, </td>
  272. </tr>
  273. <tr>
  274. <td class="paramkey"></td>
  275. <td></td>
  276. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  277. <td class="paramname"><em>Max</em>&#160;</td>
  278. </tr>
  279. <tr>
  280. <td></td>
  281. <td>)</td>
  282. <td></td><td></td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  287. <dl class="params"><dt>Parameters</dt><dd>
  288. <table class="params">
  289. <tr><td class="paramname">Min</td><td></td></tr>
  290. <tr><td class="paramname">Max</td><td></td></tr>
  291. </table>
  292. </dd>
  293. </dl>
  294. <dl class="tparams"><dt>Template Parameters</dt><dd>
  295. <table class="tparams">
  296. <tr><td class="paramname">T</td><td>Value type. Currently supported: float or double. </td></tr>
  297. <tr><td class="paramname">vecType</td><td>A vertor type: tvec1, tvec2, tvec3, tvec4 or compatible </td></tr>
  298. </table>
  299. </dd>
  300. </dl>
  301. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  302. </div>
  303. </div>
  304. <a class="anchor" id="gaa9a6fc2d7a295b3857f7db23b1053d9d"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">GLM_FUNC_DECL tvec3&lt;T, defaultp&gt; glm::sphericalRand </td>
  310. <td>(</td>
  311. <td class="paramtype">T&#160;</td>
  312. <td class="paramname"><em>Radius</em></td><td>)</td>
  313. <td></td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
  318. <dl class="params"><dt>Parameters</dt><dd>
  319. <table class="params">
  320. <tr><td class="paramname">Radius</td><td></td></tr>
  321. </table>
  322. </dd>
  323. </dl>
  324. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  325. </div>
  326. </div>
  327. </div><!-- contents -->
  328. <!-- start footer part -->
  329. <hr class="footer"/><address class="footer"><small>
  330. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  331. <img class="footer" src="doxygen.png" alt="doxygen"/>
  332. </a> 1.8.10
  333. </small></address>
  334. </body>
  335. </html>