Updated API doc

2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions
--- a/doc/api/a00175.html
+++ b/doc/api/a00175.html
@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.10"/>
-<title>0.9.9 API documenation: GLM_GTC_random</title>
+<title>0.9.9 API documenation: GLM_GTX_common</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -77,234 +77,75 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  <div class="summary">
 <a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
-<div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00156.html">GTC Extensions (Stable)</a></div></div>  </div>
+<div class="title">GLM_GTX_common<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">

-<p>Generate random number from various distribution methods.  
+<p>Include &lt;<a class="el" href="a00016.html" title="GLM_GTX_common ">glm/gtx/common.hpp</a>&gt; to use the features of this extension.  
 <a href="#details">More...</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
-<tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a> (T Radius)</td></tr>
-<tr class="memdesc:ga7c53b7797f3147af68a11c767679fa3f"><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="a00175.html#ga7c53b7797f3147af68a11c767679fa3f">More...</a><br /></td></tr>
-<tr class="separator:ga7c53b7797f3147af68a11c767679fa3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
-<tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a> (T Radius)</td></tr>
-<tr class="memdesc:ga9dd05c36025088fae25b97c869e88517"><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="a00175.html#ga9dd05c36025088fae25b97c869e88517">More...</a><br /></td></tr>
-<tr class="separator:ga9dd05c36025088fae25b97c869e88517"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
-<tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a> (T Radius)</td></tr>
-<tr class="memdesc:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><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="a00175.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">More...</a><br /></td></tr>
-<tr class="separator:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
-<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="a00175.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
-<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="a00175.html#ga5193a83e49e4fdc5652c084711083574">More...</a><br /></td></tr>
-<tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
-<tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga04e241ab88374a477a2c2ceadd2fa03d">linearRand</a> (genType Min, genType Max)</td></tr>
-<tr class="memdesc:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution.  <a href="a00175.html#ga04e241ab88374a477a2c2ceadd2fa03d">More...</a><br /></td></tr>
-<tr class="separator:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gab22e2ce52a7cfb06314622a8e513d047"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
-<tr class="memitem:gab22e2ce52a7cfb06314622a8e513d047"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gab22e2ce52a7cfb06314622a8e513d047">linearRand</a> (vec&lt; L, T, P &gt; const &amp;Min, vec&lt; L, T, P &gt; const &amp;Max)</td></tr>
-<tr class="memdesc:gab22e2ce52a7cfb06314622a8e513d047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution.  <a href="a00175.html#gab22e2ce52a7cfb06314622a8e513d047">More...</a><br /></td></tr>
-<tr class="separator:gab22e2ce52a7cfb06314622a8e513d047"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
-<tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a> (T Radius)</td></tr>
-<tr class="memdesc:ga22f90fcaccdf001c516ca90f6428e138"><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="a00175.html#ga22f90fcaccdf001c516ca90f6428e138">More...</a><br /></td></tr>
-<tr class="separator:ga22f90fcaccdf001c516ca90f6428e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae5e80425df9833164ad469e83b475fb4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
+<tr class="memitem:gae5e80425df9833164ad469e83b475fb4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gae5e80425df9833164ad469e83b475fb4">fmod</a> (vec&lt; L, T, Q &gt; const &amp;v)</td></tr>
+<tr class="memdesc:gae5e80425df9833164ad469e83b475fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to 'mod' but with a different rounding and integer support.  <a href="a00175.html#gae5e80425df9833164ad469e83b475fb4">More...</a><br /></td></tr>
+<tr class="separator:gae5e80425df9833164ad469e83b475fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
+<tr class="memitem:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::bool_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga74aa7c7462245d83bd5a9edf9c6c2d91">isdenormal</a> (genType const &amp;x)</td></tr>
+<tr class="memdesc:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if x is a denormalized number Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format.  <a href="a00175.html#ga74aa7c7462245d83bd5a9edf9c6c2d91">More...</a><br /></td></tr>
+<tr class="separator:ga74aa7c7462245d83bd5a9edf9c6c2d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p>Generate random number from various distribution methods. </p>
-<p>&lt;<a class="el" href="a00093.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
+<p>Include &lt;<a class="el" href="a00016.html" title="GLM_GTX_common ">glm/gtx/common.hpp</a>&gt; to use the features of this extension. </p>
+<p>Provide functions to increase the compatibility with Cg and HLSL languages </p>
 <h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="ga7c53b7797f3147af68a11c767679fa3f"></a>
+<a class="anchor" id="gae5e80425df9833164ad469e83b475fb4"></a>
 <div class="memitem">
 <div class="memproto">
      <table class="memname">
        <tr>
-          <td class="memname">GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; glm::ballRand </td>
+          <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::fmod </td>
          <td>(</td>
-          <td class="paramtype">T&#160;</td>
-          <td class="paramname"><em>Radius</em></td><td>)</td>
+          <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
+          <td class="paramname"><em>v</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
 </div><div class="memdoc">

-<p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
+<p>Similar to 'mod' but with a different rounding and integer support. </p>
+<p>Returns 'x - y * trunc(x/y)' instead of 'x - y * floor(x/y)'</p>
+<dl class="section see"><dt>See also</dt><dd><a href="http://stackoverflow.com/questions/7610631/glsl-mod-vs-hlsl-fmod">GLSL mod vs HLSL fmod</a> </dd>
+<dd>
+<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd></dl>

 </div>
 </div>
-<a class="anchor" id="ga9dd05c36025088fae25b97c869e88517"></a>
+<a class="anchor" id="ga74aa7c7462245d83bd5a9edf9c6c2d91"></a>
 <div class="memitem">
 <div class="memproto">
      <table class="memname">
        <tr>
-          <td class="memname">GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; glm::circularRand </td>
+          <td class="memname">GLM_FUNC_DECL genType::bool_type glm::isdenormal </td>
          <td>(</td>
-          <td class="paramtype">T&#160;</td>
-          <td class="paramname"><em>Radius</em></td><td>)</td>
+          <td class="paramtype">genType const &amp;&#160;</td>
+          <td class="paramname"><em>x</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
 </div><div class="memdoc">

-<p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="gaa0b18071f3f97dbf8bcf6f53c6fe5f73"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; glm::diskRand </td>
-          <td>(</td>
-          <td class="paramtype">T&#160;</td>
-          <td class="paramname"><em>Radius</em></td><td>)</td>
-          <td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="ga5193a83e49e4fdc5652c084711083574"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">GLM_FUNC_DECL genType glm::gaussRand </td>
-          <td>(</td>
-          <td class="paramtype">genType&#160;</td>
-          <td class="paramname"><em>Mean</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">genType&#160;</td>
-          <td class="paramname"><em>Deviation</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="ga04e241ab88374a477a2c2ceadd2fa03d"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">GLM_FUNC_DECL genType glm::linearRand </td>
-          <td>(</td>
-          <td class="paramtype">genType&#160;</td>
-          <td class="paramname"><em>Min</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">genType&#160;</td>
-          <td class="paramname"><em>Max</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
-    <tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
-  </table>
-  </dd>
-</dl>
+<p>Returns true if x is a denormalized number Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format. </p>
+<p>This format is less precise but can represent values closer to zero.</p>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
-    <tr><td class="paramname">genType</td><td>Value type. Currently supported: float or double scalars. </td></tr>
+    <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  </table>
  </dd>
 </dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="gab22e2ce52a7cfb06314622a8e513d047"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::linearRand </td>
-          <td>(</td>
-          <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
-          <td class="paramname"><em>Min</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
-          <td class="paramname"><em>Max</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
-    <tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="tparams"><dt>Template Parameters</dt><dd>
-  <table class="tparams">
-    <tr><td class="paramname">T</td><td>Value type. Currently supported: float or double.</td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="ga22f90fcaccdf001c516ca90f6428e138"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; glm::sphericalRand </td>
-          <td>(</td>
-          <td class="paramtype">T&#160;</td>
-          <td class="paramname"><em>Radius</em></td><td>)</td>
-          <td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
+<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/isnan.xml">GLSL isnan man page</a> </dd>
+<dd>
+<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>

 </div>
 </div>