Updated API doc
This commit is contained in:
Christophe Riccio
@@ -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_noise</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_color_encoding</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,98 +77,39 @@ 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_noise<div class="ingroups"><a class="el" href="a00156.html">GTC Extensions (Stable)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_color_encoding<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</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="a00077.html" title="GLM_GTC_noise ">glm/gtc/noise.hpp</a>> need to be included to use these functionalities.
|
||||
<p>Include <<a class="el" href="a00011.html" title="GLM_GTX_color_encoding ">glm/gtx/color_encoding.hpp</a>> 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:ga90db728c7010f95d97e38d1ef0339d11"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga90db728c7010f95d97e38d1ef0339d11"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#ga90db728c7010f95d97e38d1ef0339d11">perlin</a> (vec< L, T, P > const &p)</td></tr>
|
||||
<tr class="memdesc:ga90db728c7010f95d97e38d1ef0339d11"><td class="mdescLeft"> </td><td class="mdescRight">Classic perlin noise. <a href="a00172.html#ga90db728c7010f95d97e38d1ef0339d11">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga90db728c7010f95d97e38d1ef0339d11"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5c8effcc7ea8e6ab541eaaa53e62f9ec"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga5c8effcc7ea8e6ab541eaaa53e62f9ec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#ga5c8effcc7ea8e6ab541eaaa53e62f9ec">perlin</a> (vec< L, T, P > const &p, vec< L, T, P > const &rep)</td></tr>
|
||||
<tr class="memdesc:ga5c8effcc7ea8e6ab541eaaa53e62f9ec"><td class="mdescLeft"> </td><td class="mdescRight">Periodic perlin noise. <a href="a00172.html#ga5c8effcc7ea8e6ab541eaaa53e62f9ec">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga5c8effcc7ea8e6ab541eaaa53e62f9ec"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7b869f8b8bf2228001063c5f3bd4646d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga7b869f8b8bf2228001063c5f3bd4646d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#ga7b869f8b8bf2228001063c5f3bd4646d">simplex</a> (vec< L, T, P > const &p)</td></tr>
|
||||
<tr class="memdesc:ga7b869f8b8bf2228001063c5f3bd4646d"><td class="mdescLeft"> </td><td class="mdescRight">Simplex noise. <a href="a00172.html#ga7b869f8b8bf2228001063c5f3bd4646d">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7b869f8b8bf2228001063c5f3bd4646d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad12f4f65022b2c80e33fcba2ced0dc48"><td class="memTemplParams" colspan="2"><a class="anchor" id="gad12f4f65022b2c80e33fcba2ced0dc48"></a>
|
||||
template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gad12f4f65022b2c80e33fcba2ced0dc48"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#gad12f4f65022b2c80e33fcba2ced0dc48">convertD65XYZToD50XYZ</a> (vec< 3, T, Q > const &ColorD65XYZ)</td></tr>
|
||||
<tr class="memdesc:gad12f4f65022b2c80e33fcba2ced0dc48"><td class="mdescLeft"> </td><td class="mdescRight">Convert a D65 YUV color to D50 YUV. <br /></td></tr>
|
||||
<tr class="separator:gad12f4f65022b2c80e33fcba2ced0dc48"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5265386fc3ac29e4c580d37ed470859c"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga5265386fc3ac29e4c580d37ed470859c"></a>
|
||||
template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga5265386fc3ac29e4c580d37ed470859c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#ga5265386fc3ac29e4c580d37ed470859c">convertD65XYZToLinearSRGB</a> (vec< 3, T, Q > const &ColorD65XYZ)</td></tr>
|
||||
<tr class="memdesc:ga5265386fc3ac29e4c580d37ed470859c"><td class="mdescLeft"> </td><td class="mdescRight">Convert a D65 YUV color to linear sRGB. <br /></td></tr>
|
||||
<tr class="separator:ga5265386fc3ac29e4c580d37ed470859c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga1522ba180e3d83d554a734056da031f9"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga1522ba180e3d83d554a734056da031f9"></a>
|
||||
template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga1522ba180e3d83d554a734056da031f9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#ga1522ba180e3d83d554a734056da031f9">convertLinearSRGBToD50XYZ</a> (vec< 3, T, Q > const &ColorLinearSRGB)</td></tr>
|
||||
<tr class="memdesc:ga1522ba180e3d83d554a734056da031f9"><td class="mdescLeft"> </td><td class="mdescRight">Convert a linear sRGB color to D50 YUV. <br /></td></tr>
|
||||
<tr class="separator:ga1522ba180e3d83d554a734056da031f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaf9e130d9d4ccf51cc99317de7449f369"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaf9e130d9d4ccf51cc99317de7449f369"></a>
|
||||
template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaf9e130d9d4ccf51cc99317de7449f369"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00172.html#gaf9e130d9d4ccf51cc99317de7449f369">convertLinearSRGBToD65XYZ</a> (vec< 3, T, Q > const &ColorLinearSRGB)</td></tr>
|
||||
<tr class="memdesc:gaf9e130d9d4ccf51cc99317de7449f369"><td class="mdescLeft"> </td><td class="mdescRight">Convert a linear sRGB color to D65 YUV. <br /></td></tr>
|
||||
<tr class="separator:gaf9e130d9d4ccf51cc99317de7449f369"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<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="a00077.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="ga90db728c7010f95d97e38d1ef0339d11"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::perlin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>p</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Classic perlin noise. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.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="ga5c8effcc7ea8e6ab541eaaa53e62f9ec"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::perlin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>p</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>rep</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Periodic perlin noise. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.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="ga7b869f8b8bf2228001063c5f3bd4646d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::simplex </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>p</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Simplex noise. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00172.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>
|
||||
<p>Include <<a class="el" href="a00011.html" title="GLM_GTX_color_encoding ">glm/gtx/color_encoding.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Allow to perform bit operations on integer values </p>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user