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: Geometric functions</title>
|
||||
<title>0.9.9 API documenation: GLM_GTC_color_space</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,324 +77,71 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Geometric functions<div class="ingroups"><a class="el" href="a00158.html">GLM Core</a></div></div> </div>
|
||||
<div class="title">GLM_GTC_color_space<div class="ingroups"><a class="el" href="a00147.html">Stable extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>These operate on vectors as vectors, not component-wise.
|
||||
<p>Include <<a class="el" href="a00012.html" title="GLM_GTC_color_space ">glm/gtc/color_space.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:gaf48bb3113e27775dfa907960a6927d33"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gaf48bb3113e27775dfa907960a6927d33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">cross</a> (vec< 3, T, P > const &x, vec< 3, T, P > const &y)</td></tr>
|
||||
<tr class="memdesc:gaf48bb3113e27775dfa907960a6927d33"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cross product of x and y. <a href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaf48bb3113e27775dfa907960a6927d33"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">distance</a> (vec< L, T, P > const &p0, vec< L, T, P > const &p1)</td></tr>
|
||||
<tr class="memdesc:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). <a href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">More...</a><br /></td></tr>
|
||||
<tr class="separator:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">dot</a> (vec< L, T, P > const &x, vec< L, T, P > const &y)</td></tr>
|
||||
<tr class="memdesc:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y. <a href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga4b1a93be2515b8de5ba413eb636396da"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga4b1a93be2515b8de5ba413eb636396da"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">faceforward</a> (vec< L, T, P > const &N, vec< L, T, P > const &I, vec< L, T, P > const &Nref)</td></tr>
|
||||
<tr class="memdesc:ga4b1a93be2515b8de5ba413eb636396da"><td class="mdescLeft"> </td><td class="mdescRight">If dot(Nref, I) < 0.0, return N, otherwise, return -N. <a href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga4b1a93be2515b8de5ba413eb636396da"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">length</a> (vec< L, T, P > const &x)</td></tr>
|
||||
<tr class="memdesc:ga9363516a0cffaa7c44adea39d2b0334d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">normalize</a> (vec< L, T, P > const &x)</td></tr>
|
||||
<tr class="memdesc:ga8263c6c2b8ff1719c89728d643bba27a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1. <a href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">reflect</a> (vec< L, T, P > const &I, vec< L, T, P > const &N)</td></tr>
|
||||
<tr class="memdesc:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. <a href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">More...</a><br /></td></tr>
|
||||
<tr class="separator:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae7fdf06db18e429a29c7d4169e8459be"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gae7fdf06db18e429a29c7d4169e8459be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">refract</a> (vec< L, T, P > const &I, vec< L, T, P > const &N, T eta)</td></tr>
|
||||
<tr class="memdesc:gae7fdf06db18e429a29c7d4169e8459be"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. <a href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae7fdf06db18e429a29c7d4169e8459be"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga42239e7b3da900f7ef37cec7e2476579"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga42239e7b3da900f7ef37cec7e2476579"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga42239e7b3da900f7ef37cec7e2476579">convertLinearToSRGB</a> (vec< L, T, Q > const &ColorLinear)</td></tr>
|
||||
<tr class="memdesc:ga42239e7b3da900f7ef37cec7e2476579"><td class="mdescLeft"> </td><td class="mdescRight">Convert a linear color to sRGB color using a standard gamma correction. <a href="a00150.html#ga42239e7b3da900f7ef37cec7e2476579">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga42239e7b3da900f7ef37cec7e2476579"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaace0a21167d13d26116c283009af57f6"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaace0a21167d13d26116c283009af57f6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaace0a21167d13d26116c283009af57f6">convertLinearToSRGB</a> (vec< L, T, Q > const &ColorLinear, T Gamma)</td></tr>
|
||||
<tr class="memdesc:gaace0a21167d13d26116c283009af57f6"><td class="mdescLeft"> </td><td class="mdescRight">Convert a linear color to sRGB color using a custom gamma correction. <a href="a00150.html#gaace0a21167d13d26116c283009af57f6">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaace0a21167d13d26116c283009af57f6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga16c798b7a226b2c3079dedc55083d187"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga16c798b7a226b2c3079dedc55083d187"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga16c798b7a226b2c3079dedc55083d187">convertSRGBToLinear</a> (vec< L, T, Q > const &ColorSRGB)</td></tr>
|
||||
<tr class="memdesc:ga16c798b7a226b2c3079dedc55083d187"><td class="mdescLeft"> </td><td class="mdescRight">Convert a sRGB color to linear color using a standard gamma correction. <a href="a00150.html#ga16c798b7a226b2c3079dedc55083d187">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga16c798b7a226b2c3079dedc55083d187"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad1b91f27a9726c9cb403f9fee6e2e200"><td class="memTemplParams" colspan="2"><a class="anchor" id="gad1b91f27a9726c9cb403f9fee6e2e200"></a>
|
||||
template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gad1b91f27a9726c9cb403f9fee6e2e200"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gad1b91f27a9726c9cb403f9fee6e2e200">convertSRGBToLinear</a> (vec< L, T, Q > const &ColorSRGB, T Gamma)</td></tr>
|
||||
<tr class="memdesc:gad1b91f27a9726c9cb403f9fee6e2e200"><td class="mdescLeft"> </td><td class="mdescRight">Convert a sRGB color to linear color using a custom gamma correction. <br /></td></tr>
|
||||
<tr class="separator:gad1b91f27a9726c9cb403f9fee6e2e200"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>These operate on vectors as vectors, not component-wise. </p>
|
||||
<p>Include <<a class="el" href="a00012.html" title="GLM_GTC_color_space ">glm/gtc/color_space.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Allow to perform bit operations on integer values </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gaf48bb3113e27775dfa907960a6927d33"></a>
|
||||
<a class="anchor" id="ga42239e7b3da900f7ef37cec7e2476579"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, P> glm::cross </td>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::convertLinearToSRGB </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, P > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, 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>Returns the cross product of x and y. </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cross.xml">GLSL cross 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gadb370a015ab4c544ddd2cb0b2ea1cec8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::distance </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>p0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>p1</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/distance.xml">GLSL distance 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::dot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, 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>Returns the dot product of x and y, i.e., result = x * y. </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/dot.xml">GLSL dot 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga4b1a93be2515b8de5ba413eb636396da"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::faceforward </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>N</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>I</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>Nref</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>If dot(Nref, I) < 0.0, return N, otherwise, return -N. </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/faceforward.xml">GLSL faceforward 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9363516a0cffaa7c44adea39d2b0334d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::length </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>ColorLinear</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the length of x, i.e., sqrt(x * x). </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/length.xml">GLSL length 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.5 Geometric Functions</a> </dd></dl>
|
||||
<p>Convert a linear color to sRGB color using a standard gamma correction. </p>
|
||||
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8263c6c2b8ff1719c89728d643bba27a"></a>
|
||||
<a class="anchor" id="gaace0a21167d13d26116c283009af57f6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::normalize </td>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::convertLinearToSRGB </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns a vector in the same direction as x but with length of 1. </p>
|
||||
<p>According to issue 10 GLSL 1.10 specification, if length(x) == 0 then result is undefined and generate an error.</p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/normalize.xml">GLSL normalize 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gad0ef4d78d209c4a3f90b9df53afa23a9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::reflect </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>I</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>N</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/reflect.xml">GLSL reflect 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.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gae7fdf06db18e429a29c7d4169e8459be"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::refract </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>I</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, P > const & </td>
|
||||
<td class="paramname"><em>N</em>, </td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>ColorLinear</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>eta</em> </td>
|
||||
<td class="paramname"><em>Gamma</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -404,17 +151,27 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. </p>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
|
||||
<tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/refract.xml">GLSL refract 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.5 Geometric Functions</a> </dd></dl>
|
||||
<p>Convert a linear color to sRGB color using a custom gamma correction. </p>
|
||||
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga16c798b7a226b2c3079dedc55083d187"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::convertSRGBToLinear </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>ColorSRGB</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Convert a sRGB color to linear color using a standard gamma correction. </p>
|
||||
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user