a00178.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  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.7: 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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.7
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00160.html">GTC Extensions (Stable)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga5506dee301160e3a06aef9b9bc7a0a83"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  49. <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="a00178.html#ga5506dee301160e3a06aef9b9bc7a0a83">ballRand</a> (T Radius)</td></tr>
  50. <tr class="separator:ga5506dee301160e3a06aef9b9bc7a0a83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gae989c26a2899b2fb7444abe7c275c29c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  52. <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="a00178.html#gae989c26a2899b2fb7444abe7c275c29c">circularRand</a> (T Radius)</td></tr>
  53. <tr class="separator:gae989c26a2899b2fb7444abe7c275c29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:gad3a3ee7d26502a31ba552cb627a68606"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  55. <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="a00178.html#gad3a3ee7d26502a31ba552cb627a68606">diskRand</a> (T Radius)</td></tr>
  56. <tr class="separator:gad3a3ee7d26502a31ba552cb627a68606"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  58. <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="a00178.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
  59. <tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="memTemplParams" colspan="2">template&lt;typename genTYpe &gt; </td></tr>
  61. <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="a00178.html#ga12aebc19b85a8c736f5801c2f7b9b716">linearRand</a> (genTYpe Min, genTYpe Max)</td></tr>
  62. <tr class="separator:ga12aebc19b85a8c736f5801c2f7b9b716"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:gaa9a6fc2d7a295b3857f7db23b1053d9d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  64. <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="a00178.html#gaa9a6fc2d7a295b3857f7db23b1053d9d">sphericalRand</a> (T Radius)</td></tr>
  65. <tr class="separator:gaa9a6fc2d7a295b3857f7db23b1053d9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table>
  67. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  68. <p>Generate random number from various distribution methods. </p>
  69. <p>&lt;<a class="el" href="a00096.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
  70. <h2 class="groupheader">Function Documentation</h2>
  71. <a class="anchor" id="ga5506dee301160e3a06aef9b9bc7a0a83"></a>
  72. <div class="memitem">
  73. <div class="memproto">
  74. <table class="memname">
  75. <tr>
  76. <td class="memname">GLM_FUNC_DECL tvec3&lt;T, defaultp&gt; glm::ballRand </td>
  77. <td>(</td>
  78. <td class="paramtype">T&#160;</td>
  79. <td class="paramname"><em>Radius</em></td><td>)</td>
  80. <td></td>
  81. </tr>
  82. </table>
  83. </div><div class="memdoc">
  84. <p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
  85. <dl class="params"><dt>Parameters</dt><dd>
  86. <table class="params">
  87. <tr><td class="paramname">Radius</td><td></td></tr>
  88. </table>
  89. </dd>
  90. </dl>
  91. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  92. </div>
  93. </div>
  94. <a class="anchor" id="gae989c26a2899b2fb7444abe7c275c29c"></a>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">GLM_FUNC_DECL tvec2&lt;T, defaultp&gt; glm::circularRand </td>
  100. <td>(</td>
  101. <td class="paramtype">T&#160;</td>
  102. <td class="paramname"><em>Radius</em></td><td>)</td>
  103. <td></td>
  104. </tr>
  105. </table>
  106. </div><div class="memdoc">
  107. <p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
  108. <dl class="params"><dt>Parameters</dt><dd>
  109. <table class="params">
  110. <tr><td class="paramname">Radius</td><td></td></tr>
  111. </table>
  112. </dd>
  113. </dl>
  114. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  115. </div>
  116. </div>
  117. <a class="anchor" id="gad3a3ee7d26502a31ba552cb627a68606"></a>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">GLM_FUNC_DECL tvec2&lt;T, defaultp&gt; glm::diskRand </td>
  123. <td>(</td>
  124. <td class="paramtype">T&#160;</td>
  125. <td class="paramname"><em>Radius</em></td><td>)</td>
  126. <td></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
  131. <dl class="params"><dt>Parameters</dt><dd>
  132. <table class="params">
  133. <tr><td class="paramname">Radius</td><td></td></tr>
  134. </table>
  135. </dd>
  136. </dl>
  137. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  138. </div>
  139. </div>
  140. <a class="anchor" id="ga5193a83e49e4fdc5652c084711083574"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">GLM_FUNC_DECL genType glm::gaussRand </td>
  146. <td>(</td>
  147. <td class="paramtype">genType&#160;</td>
  148. <td class="paramname"><em>Mean</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">genType&#160;</td>
  154. <td class="paramname"><em>Deviation</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
  164. <dl class="params"><dt>Parameters</dt><dd>
  165. <table class="params">
  166. <tr><td class="paramname">Mean</td><td></td></tr>
  167. <tr><td class="paramname">Deviation</td><td></td></tr>
  168. </table>
  169. </dd>
  170. </dl>
  171. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ga12aebc19b85a8c736f5801c2f7b9b716"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">GLM_FUNC_DECL genTYpe glm::linearRand </td>
  180. <td>(</td>
  181. <td class="paramtype">genTYpe&#160;</td>
  182. <td class="paramname"><em>Min</em>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">genTYpe&#160;</td>
  188. <td class="paramname"><em>Max</em>&#160;</td>
  189. </tr>
  190. <tr>
  191. <td></td>
  192. <td>)</td>
  193. <td></td><td></td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  198. <dl class="params"><dt>Parameters</dt><dd>
  199. <table class="params">
  200. <tr><td class="paramname">Min</td><td></td></tr>
  201. <tr><td class="paramname">Max</td><td></td></tr>
  202. </table>
  203. </dd>
  204. </dl>
  205. <dl class="tparams"><dt>Template Parameters</dt><dd>
  206. <table class="tparams">
  207. <tr><td class="paramname">genType</td><td>Value type. Currently supported: half (not recommanded), float or double scalars and vectors. </td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="gaa9a6fc2d7a295b3857f7db23b1053d9d"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">GLM_FUNC_DECL tvec3&lt;T, defaultp&gt; glm::sphericalRand </td>
  220. <td>(</td>
  221. <td class="paramtype">T&#160;</td>
  222. <td class="paramname"><em>Radius</em></td><td>)</td>
  223. <td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">Radius</td><td></td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00178.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  235. </div>
  236. </div>
  237. </div><!-- contents -->
  238. <!-- start footer part -->
  239. <hr class="footer"/><address class="footer"><small>
  240. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  241. <img class="footer" src="doxygen.png" alt="doxygen"/>
  242. </a> 1.8.10
  243. </small></address>
  244. </body>
  245. </html>