Updated API documentation

This commit is contained in:
Christophe Riccio
2018-05-08 13:51:58 +02:00
parent 4d4dbcade6
commit c3a41b0ef8
470 changed files with 72126 additions and 68787 deletions

View File

@@ -99,40 +99,40 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_random extension included&quot;)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<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>&#160;<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>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; 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>&#160; 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>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00161.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; Min, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; Max);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00167.html#ga94731130c298a9ff5e5025fdee6d97a0">linearRand</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; Min, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; Max);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; 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>&#160; 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>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; <a class="code" href="a00161.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a>(T Radius);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; <a class="code" href="a00167.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a>(T Radius);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; <a class="code" href="a00161.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a>(T Radius);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; <a class="code" href="a00167.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a>(T Radius);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; <a class="code" href="a00161.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a>(T Radius);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; <a class="code" href="a00167.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a>(T Radius);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; <a class="code" href="a00161.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a>(T Radius);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; <a class="code" href="a00167.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a>(T Radius);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#include &quot;random.inl&quot;</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&lt; 3, T, defaultp &gt; 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&lt; 2, T, defaultp &gt; 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&lt; 3, T, defaultp &gt; 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&lt; 2, T, defaultp &gt; 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&lt; L, T, Q &gt; linearRand(vec&lt; L, T, Q &gt; const &amp;Min, vec&lt; L, T, Q &gt; const &amp;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&lt; 3, T, defaultp &gt; 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&lt; 2, T, defaultp &gt; 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&lt; 2, T, defaultp &gt; 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&lt; 3, T, defaultp &gt; 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&lt; L, T, Q &gt; linearRand(vec&lt; L, T, Q &gt; const &amp;Min, vec&lt; L, T, Q &gt; const &amp;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>