Updated API documentation
This commit is contained in:
@@ -99,40 +99,40 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"># pragma message("GLM: GLM_GTC_random extension included")</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="a00138.html">glm</a></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  GLM_FUNC_DECL genType <a class="code" href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(genType Min, genType Max);</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  GLM_FUNC_DECL genType <a class="code" href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(genType Min, genType Max);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(vec<L, T, Q> <span class="keyword">const</span>& Min, vec<L, T, Q> <span class="keyword">const</span>& Max);</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(vec<L, T, Q> <span class="keyword">const</span>& Min, vec<L, T, Q> <span class="keyword">const</span>& Max);</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  GLM_FUNC_DECL genType <a class="code" href="a00161.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a>(genType Mean, genType Deviation);</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  GLM_FUNC_DECL genType <a class="code" href="a00167.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a>(genType Mean, genType Deviation);</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  GLM_FUNC_DECL vec<2, T, defaultp> <a class="code" href="a00161.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  GLM_FUNC_DECL vec<2, T, defaultp> <a class="code" href="a00167.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  GLM_FUNC_DECL vec<3, T, defaultp> <a class="code" href="a00161.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  GLM_FUNC_DECL vec<3, T, defaultp> <a class="code" href="a00167.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
||||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  GLM_FUNC_DECL vec<2, T, defaultp> <a class="code" href="a00161.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  GLM_FUNC_DECL vec<2, T, defaultp> <a class="code" href="a00167.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  GLM_FUNC_DECL vec<3, T, defaultp> <a class="code" href="a00161.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  GLM_FUNC_DECL vec<3, T, defaultp> <a class="code" href="a00167.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a>(T Radius);</div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }<span class="comment">//namespace glm</span></div>
|
||||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
||||
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#include "random.inl"</span></div>
|
||||
<div class="ttc" id="a00161_html_ga7c53b7797f3147af68a11c767679fa3f"><div class="ttname"><a href="a00161.html#ga7c53b7797f3147af68a11c767679fa3f">glm::ballRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, defaultp > ballRand(T Radius)</div><div class="ttdoc">Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of...</div></div>
|
||||
<div class="ttc" id="a00161_html_ga9dd05c36025088fae25b97c869e88517"><div class="ttname"><a href="a00161.html#ga9dd05c36025088fae25b97c869e88517">glm::circularRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 2, T, defaultp > circularRand(T Radius)</div><div class="ttdoc">Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius...</div></div>
|
||||
<div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
|
||||
<div class="ttc" id="a00161_html_ga5193a83e49e4fdc5652c084711083574"><div class="ttname"><a href="a00161.html#ga5193a83e49e4fdc5652c084711083574">glm::gaussRand</a></div><div class="ttdeci">GLM_FUNC_DECL genType gaussRand(genType Mean, genType Deviation)</div><div class="ttdoc">Generate random numbers in the interval [Min, Max], according a gaussian distribution. </div></div>
|
||||
<div class="ttc" id="a00161_html_ga22f90fcaccdf001c516ca90f6428e138"><div class="ttname"><a href="a00161.html#ga22f90fcaccdf001c516ca90f6428e138">glm::sphericalRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, defaultp > sphericalRand(T Radius)</div><div class="ttdoc">Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius...</div></div>
|
||||
<div class="ttc" id="a00161_html_gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><div class="ttname"><a href="a00161.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">glm::diskRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 2, T, defaultp > diskRand(T Radius)</div><div class="ttdoc">Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a...</div></div>
|
||||
<div class="ttc" id="a00161_html_ga94731130c298a9ff5e5025fdee6d97a0"><div class="ttname"><a href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">glm::linearRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, Q > linearRand(vec< L, T, Q > const &Min, vec< L, T, Q > const &Max)</div><div class="ttdoc">Generate random numbers in the interval [Min, Max], according a linear distribution. </div></div>
|
||||
<div class="ttc" id="a00167_html_ga22f90fcaccdf001c516ca90f6428e138"><div class="ttname"><a href="a00167.html#ga22f90fcaccdf001c516ca90f6428e138">glm::sphericalRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, defaultp > sphericalRand(T Radius)</div><div class="ttdoc">Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius...</div></div>
|
||||
<div class="ttc" id="a00167_html_ga5193a83e49e4fdc5652c084711083574"><div class="ttname"><a href="a00167.html#ga5193a83e49e4fdc5652c084711083574">glm::gaussRand</a></div><div class="ttdeci">GLM_FUNC_DECL genType gaussRand(genType Mean, genType Deviation)</div><div class="ttdoc">Generate random numbers in the interval [Min, Max], according a gaussian distribution. </div></div>
|
||||
<div class="ttc" id="a00167_html_gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><div class="ttname"><a href="a00167.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">glm::diskRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 2, T, defaultp > diskRand(T Radius)</div><div class="ttdoc">Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a...</div></div>
|
||||
<div class="ttc" id="a00138_html"><div class="ttname"><a href="a00138.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
|
||||
<div class="ttc" id="a00167_html_ga9dd05c36025088fae25b97c869e88517"><div class="ttname"><a href="a00167.html#ga9dd05c36025088fae25b97c869e88517">glm::circularRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 2, T, defaultp > circularRand(T Radius)</div><div class="ttdoc">Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius...</div></div>
|
||||
<div class="ttc" id="a00167_html_ga7c53b7797f3147af68a11c767679fa3f"><div class="ttname"><a href="a00167.html#ga7c53b7797f3147af68a11c767679fa3f">glm::ballRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, defaultp > ballRand(T Radius)</div><div class="ttdoc">Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of...</div></div>
|
||||
<div class="ttc" id="a00167_html_ga94731130c298a9ff5e5025fdee6d97a0"><div class="ttname"><a href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">glm::linearRand</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, Q > linearRand(vec< L, T, Q > const &Min, vec< L, T, Q > const &Max)</div><div class="ttdoc">Generate random numbers in the interval [Min, Max], according a linear distribution. </div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user