diff options
Diffstat (limited to '3rdparty/glm/doc/api/a00147.html')
| -rw-r--r-- | 3rdparty/glm/doc/api/a00147.html | 338 |
1 files changed, 123 insertions, 215 deletions
diff --git a/3rdparty/glm/doc/api/a00147.html b/3rdparty/glm/doc/api/a00147.html index cf07edba796..2e27dd8c154 100644 --- a/3rdparty/glm/doc/api/a00147.html +++ b/3rdparty/glm/doc/api/a00147.html @@ -4,16 +4,10 @@ <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.8: Exponential functions</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> @@ -22,9 +16,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td> + <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">0.9.9 API documenation + <div id="projectname">0.9.8 </div> </td> </tr> @@ -33,314 +27,231 @@ </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">Geometric functions<div class="ingroups"><a class="el" href="a00155.html">GLM Core</a></div></div> </div> +<div class="title">Exponential functions<div class="ingroups"><a class="el" href="a00156.html">GLM Core</a></div></div> </div> </div><!--header--> <div class="contents"> - -<p>These operate on vectors as vectors, not component-wise. -<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:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr> -<tr class="memitem:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gafe2cae8cb26fd44be62aee97369d0af8">cross</a> (tvec3< T, P > const &x, tvec3< T, P > const &y)</td></tr> -<tr class="memdesc:gafe2cae8cb26fd44be62aee97369d0af8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cross product of x and y. <a href="a00147.html#gafe2cae8cb26fd44be62aee97369d0af8">More...</a><br /></td></tr> -<tr class="separator:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga7ca317dde0d7e94d920153554d4a02a8">distance</a> (vecType< T, P > const &p0, vecType< T, P > const &p1)</td></tr> -<tr class="memdesc:ga7ca317dde0d7e94d920153554d4a02a8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). <a href="a00147.html#ga7ca317dde0d7e94d920153554d4a02a8">More...</a><br /></td></tr> -<tr class="separator:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y. <a href="a00147.html#ga7dada304da2ba7dd3376ab4f178c3f6b">More...</a><br /></td></tr> -<tr class="separator:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">faceforward</a> (vecType< T, P > const &N, vecType< T, P > const &I, vecType< T, P > const &Nref)</td></tr> -<tr class="memdesc:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="mdescLeft"> </td><td class="mdescRight">If dot(Nref, I) < 0.0, return N, otherwise, return -N. <a href="a00147.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">More...</a><br /></td></tr> -<tr class="separator:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga18d45e3d4c7705e67ccfabd99e521604">length</a> (vecType< T, P > const &x)</td></tr> -<tr class="memdesc:ga18d45e3d4c7705e67ccfabd99e521604"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00147.html#ga18d45e3d4c7705e67ccfabd99e521604">More...</a><br /></td></tr> -<tr class="separator:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gada9451ec170a36fe53552812b9c03a68"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gada9451ec170a36fe53552812b9c03a68"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gada9451ec170a36fe53552812b9c03a68">normalize</a> (vecType< T, P > const &x)</td></tr> -<tr class="memdesc:gada9451ec170a36fe53552812b9c03a68"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1. <a href="a00147.html#gada9451ec170a36fe53552812b9c03a68">More...</a><br /></td></tr> -<tr class="separator:gada9451ec170a36fe53552812b9c03a68"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr> -<tr class="memitem:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a> (genType const &I, genType const &N)</td></tr> -<tr class="memdesc:gab63646fc36b81cf69d3ce123a72f76f2"><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="a00147.html#gab63646fc36b81cf69d3ce123a72f76f2">More...</a><br /></td></tr> -<tr class="separator:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gab7e7cdf4403931a5f7b74560ad64159b">refract</a> (vecType< T, P > const &I, vecType< T, P > const &N, T eta)</td></tr> -<tr class="memdesc:gab7e7cdf4403931a5f7b74560ad64159b"><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="a00147.html#gab7e7cdf4403931a5f7b74560ad64159b">More...</a><br /></td></tr> -<tr class="separator:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga25e54a7f44fc49ec6ac6ffc7675cf04a">exp</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:ga25e54a7f44fc49ec6ac6ffc7675cf04a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga42ca440d9062f1f456f5a9e896378f9c">exp2</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:ga42ca440d9062f1f456f5a9e896378f9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga599103d4fe4ef2234761ba8da7268627"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga599103d4fe4ef2234761ba8da7268627"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga599103d4fe4ef2234761ba8da7268627">inversesqrt</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:ga599103d4fe4ef2234761ba8da7268627"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga21efca311e62d233de0ae96bab126b83"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga21efca311e62d233de0ae96bab126b83"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga21efca311e62d233de0ae96bab126b83">log</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:ga21efca311e62d233de0ae96bab126b83"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabae30945338a555a03733f00dad95d0d"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gabae30945338a555a03733f00dad95d0d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gabae30945338a555a03733f00dad95d0d">log2</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:gabae30945338a555a03733f00dad95d0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga082b332a4b7c6ad1d43e09ff19e214dd">pow</a> (vecType< T, P > const &base, vecType< T, P > const &exponent)</td></tr> +<tr class="separator:ga082b332a4b7c6ad1d43e09ff19e214dd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae7ac2e44c14d4e8004098d0bfba6e2b8"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gae7ac2e44c14d4e8004098d0bfba6e2b8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gae7ac2e44c14d4e8004098d0bfba6e2b8">sqrt</a> (vecType< T, P > const &v)</td></tr> +<tr class="separator:gae7ac2e44c14d4e8004098d0bfba6e2b8"><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>These all operate component-wise. </p> +<p>The description is per component. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gafe2cae8cb26fd44be62aee97369d0af8"></a> +<a class="anchor" id="ga25e54a7f44fc49ec6ac6ffc7675cf04a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL tvec3<T, P> glm::cross </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::exp </td> <td>(</td> - <td class="paramtype">tvec3< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">tvec3< T, P > const & </td> - <td class="paramname"><em>y</em> </td> - </tr> - <tr> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>v</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the cross product of x and y. </p> +<p>Returns the natural exponentiation of x, i.e., e^x. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>exp function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">valType</td><td>Floating-point scalar types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cross.xml">GLSL cross man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="ga7ca317dde0d7e94d920153554d4a02a8"></a> +<a class="anchor" id="ga42ca440d9062f1f456f5a9e896378f9c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL T glm::distance </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::exp2 </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>p0</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>p1</em> </td> - </tr> - <tr> + <td class="paramname"><em>v</em></td><td>)</td> <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> +<p>Returns 2 raised to the v power. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>exp2 function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/distance.xml">GLSL distance man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="ga7dada304da2ba7dd3376ab4f178c3f6b"></a> +<a class="anchor" id="ga599103d4fe4ef2234761ba8da7268627"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL T glm::dot </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::inversesqrt </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></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </td> - </tr> - <tr> + <td class="paramname"><em>v</em></td><td>)</td> <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> +<p>Returns the reciprocal of the positive square root of v. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>inversesqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/dot.xml">GLSL dot man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="gaea854e5aec1b5839832ac2dfc7cd3c0d"></a> +<a class="anchor" id="ga21efca311e62d233de0ae96bab126b83"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::faceforward </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::log </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>N</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>v</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>I</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">vecType< 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> +<p>Returns the natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. </p> +<p>Results are undefined if v <= 0.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>log function is defined for input values of v defined in the range (0, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/faceforward.xml">GLSL faceforward man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="ga18d45e3d4c7705e67ccfabd99e521604"></a> +<a class="anchor" id="gabae30945338a555a03733f00dad95d0d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL T glm::length </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::log2 </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em></td><td>)</td> + <td class="paramname"><em>v</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the length of x, i.e., sqrt(x * x). </p> +<p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>log2 function is defined for input values of v defined in the range (0, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/length.xml">GLSL length man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="gada9451ec170a36fe53552812b9c03a68"></a> +<a class="anchor" id="ga082b332a4b7c6ad1d43e09ff19e214dd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::normalize </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::pow </td> <td>(</td> <td class="paramtype">vecType< 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="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="gab63646fc36b81cf69d3ce123a72f76f2"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">GLM_FUNC_DECL genType glm::reflect </td> - <td>(</td> - <td class="paramtype">genType const & </td> - <td class="paramname"><em>I</em>, </td> + <td class="paramname"><em>base</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">genType const & </td> - <td class="paramname"><em>N</em> </td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>exponent</em> </td> </tr> <tr> <td></td> @@ -350,59 +261,56 @@ Functions</h2></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> +<p>Returns 'base' raised to the power 'exponent'. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">base</td><td>Floating point value. pow function is defined for input values of 'base' defined in the range (inf-, inf+) in the limit of the type precision. </td></tr> + <tr><td class="paramname">exponent</td><td>Floating point value representing the 'exponent'. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/reflect.xml">GLSL reflect man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> -<a class="anchor" id="gab7e7cdf4403931a5f7b74560ad64159b"></a> +<a class="anchor" id="gae7ac2e44c14d4e8004098d0bfba6e2b8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::refract </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::sqrt </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>I</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>v</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>N</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">T </td> - <td class="paramname"><em>eta</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 normal N, and the ratio of indices of refraction eta, return the refraction vector. </p> +<p>Returns the positive square root of v. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">v</td><td>sqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type precision. </td></tr> + </table> + </dd> +</dl> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> - <tr><td class="paramname">genType</td><td>Floating-point vector types.</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 href="http://www.opengl.org/sdk/docs/manglsl/xhtml/refract.xml">GLSL refract man page</a> </dd> +<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt 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> +<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl> </div> </div> |
