a00154.html 12 KB

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