diff options
Diffstat (limited to '3rdparty/glm/doc/api/a00170.html')
| -rw-r--r-- | 3rdparty/glm/doc/api/a00170.html | 187 |
1 files changed, 77 insertions, 110 deletions
diff --git a/3rdparty/glm/doc/api/a00170.html b/3rdparty/glm/doc/api/a00170.html index d24fc5e8c10..cc438965971 100644 --- a/3rdparty/glm/doc/api/a00170.html +++ b/3rdparty/glm/doc/api/a00170.html @@ -4,10 +4,16 @@ <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.7: GLM_GTC_integer</title> +<title>0.9.9 API documenation: GLM_GTC_noise</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> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -16,9 +22,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> + <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">0.9.7 + <div id="projectname">0.9.9 API documenation </div> </td> </tr> @@ -27,115 +33,110 @@ </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.10 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> </ul> </div> </div><!-- top --> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">GLM_GTC_integer<div class="ingroups"><a class="el" href="a00160.html">GTC Extensions (Stable)</a></div></div> </div> +<div class="title">GLM_GTC_noise<div class="ingroups"><a class="el" href="a00153.html">GTC Extensions (Stable)</a></div></div> </div> </div><!--header--> <div class="contents"> + +<p>Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": <a href="https://github.com/ashima/webgl-noise">https://github.com/ashima/webgl-noise</a> Following Stefan Gustavson's paper "Simplex noise demystified": <a href="http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf">http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf</a> <<a class="el" href="a00074.html" title="GLM_GTC_noise ">glm/gtc/noise.hpp</a>> need to be included to use these functionalities. +<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:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template<typename genIUType > </td></tr> -<tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga9bd682e74bfacb005c735305207ec417">log2</a> (genIUType x)</td></tr> -<tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template<typename genIUType > </td></tr> -<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a> (genIUType x, genIUType y)</td></tr> -<tr class="separator:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">mod</a> (vecType< T, P > const &x, T y)</td></tr> -<tr class="separator:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">mod</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="separator:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga14e5975486b2b36e747861d3c65b16c1"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga14e5975486b2b36e747861d3c65b16c1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga14e5975486b2b36e747861d3c65b16c1">perlin</a> (vecType< T, P > const &p)</td></tr> +<tr class="memdesc:ga14e5975486b2b36e747861d3c65b16c1"><td class="mdescLeft"> </td><td class="mdescRight">Classic perlin noise. <a href="a00170.html#ga14e5975486b2b36e747861d3c65b16c1">More...</a><br /></td></tr> +<tr class="separator:ga14e5975486b2b36e747861d3c65b16c1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7e103ffffacb322fe2d4863c372ae2fd"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga7e103ffffacb322fe2d4863c372ae2fd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga7e103ffffacb322fe2d4863c372ae2fd">perlin</a> (vecType< T, P > const &p, vecType< T, P > const &rep)</td></tr> +<tr class="memdesc:ga7e103ffffacb322fe2d4863c372ae2fd"><td class="mdescLeft"> </td><td class="mdescRight">Periodic perlin noise. <a href="a00170.html#ga7e103ffffacb322fe2d4863c372ae2fd">More...</a><br /></td></tr> +<tr class="separator:ga7e103ffffacb322fe2d4863c372ae2fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga05f5ab240c9a3fdeee353636e464c285"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga05f5ab240c9a3fdeee353636e464c285"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga05f5ab240c9a3fdeee353636e464c285">simplex</a> (vecType< T, P > const &p)</td></tr> +<tr class="memdesc:ga05f5ab240c9a3fdeee353636e464c285"><td class="mdescLeft"> </td><td class="mdescRight">Simplex noise. <a href="a00170.html#ga05f5ab240c9a3fdeee353636e464c285">More...</a><br /></td></tr> +<tr class="separator:ga05f5ab240c9a3fdeee353636e464c285"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Allow to perform bit operations on integer values. </p> -<p><<a class="el" href="a00044.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/integer.hpp</a>> need to be included to use these functionalities. </p> +<p>Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": <a href="https://github.com/ashima/webgl-noise">https://github.com/ashima/webgl-noise</a> Following Stefan Gustavson's paper "Simplex noise demystified": <a href="http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf">http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf</a> <<a class="el" href="a00074.html" title="GLM_GTC_noise ">glm/gtc/noise.hpp</a>> need to be included to use these functionalities. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a> +<a class="anchor" id="ga14e5975486b2b36e747861d3c65b16c1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td> + <td class="memname">GLM_FUNC_DECL T glm::perlin </td> <td>(</td> - <td class="paramtype">genIUType </td> - <td class="paramname"><em>x</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns the log2 of x for integer values. </p> -<p>Can be reliably using to compute mipmap count from the texture size. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl> - -</div> -</div> -<a class="anchor" id="ga75c6fd2a143fc44e5f7b871abad539e0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">GLM_FUNC_DECL genIUType glm::mod </td> - <td>(</td> - <td class="paramtype">genIUType </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">genIUType </td> - <td class="paramname"><em>y</em> </td> - </tr> - <tr> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>p</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Modulus. </p> -<p>Returns x % y for each component in x using the floating point value y.</p> -<dl class="tparams"><dt>Template Parameters</dt><dd> - <table class="tparams"> - <tr><td class="paramname">genIUType</td><td>Integer-point scalar or vector types.</td></tr> - </table> - </dd> -</dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd> -<dd> -<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod 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> +<p>Classic perlin noise. </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise</a> </dd></dl> </div> </div> -<a class="anchor" id="gac76ae7d82ff22526bcf6d6a1b51af6c3"></a> +<a class="anchor" id="ga7e103ffffacb322fe2d4863c372ae2fd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType< T, P > mod </td> + <td class="memname">GLM_FUNC_DECL T glm::perlin </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> + <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">T </td> - <td class="paramname"><em>y</em> </td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>rep</em> </td> </tr> <tr> <td></td> @@ -145,61 +146,27 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Modulus. </p> -<p>Returns x % y for each component in x using the floating point value y.</p> -<dl class="tparams"><dt>Template Parameters</dt><dd> - <table class="tparams"> - <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr> - <tr><td class="paramname">vecType</td><td>vector types.</td></tr> - </table> - </dd> -</dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd> -<dd> -<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod 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> +<p>Periodic perlin noise. </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise</a> </dd></dl> </div> </div> -<a class="anchor" id="gaf5ae5330f6b30b4a35fb95f9a73d6134"></a> +<a class="anchor" id="ga05f5ab240c9a3fdeee353636e464c285"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType< T, P > mod </td> + <td class="memname">GLM_FUNC_DECL T glm::simplex </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>p</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Modulus. </p> -<p>Returns x % y for each component in x using the floating point value y.</p> -<dl class="tparams"><dt>Template Parameters</dt><dd> - <table class="tparams"> - <tr><td class="paramname">T</td><td>Integer scalar types. </td></tr> - <tr><td class="paramname">vecType</td><td>vector types.</td></tr> - </table> - </dd> -</dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd> -<dd> -<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod 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> +<p>Simplex noise. </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise</a> </dd></dl> </div> </div> |
