| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <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.18"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>1.0.2 API documentation: Geometric 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>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">1.0.2 API documentation
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.18 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></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="a00898.html">Core features</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
- <tr class="memitem:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaefe60743d7f415a33cbdddbe3bcf0258">cross</a> (vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)</td></tr>
- <tr class="memdesc:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cross product of x and y. <a href="a00897.html#gaefe60743d7f415a33cbdddbe3bcf0258">More...</a><br /></td></tr>
- <tr class="separator:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaa68de6c53e20dfb2dac2d20197562e3f">distance</a> (vec< L, T, Q > const &p0, vec< L, T, Q > const &p1)</td></tr>
- <tr class="memdesc:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance between p0 and p1, i.e., length(p0 - p1). <a href="a00897.html#gaa68de6c53e20dfb2dac2d20197562e3f">More...</a><br /></td></tr>
- <tr class="separator:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaec50c25dd3b13834af0bf6fd2ce3931c">dot</a> (vec< L, T, Q > const &x, vec< L, T, Q > const &y)</td></tr>
- <tr class="memdesc:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y. <a href="a00897.html#gaec50c25dd3b13834af0bf6fd2ce3931c">More...</a><br /></td></tr>
- <tr class="separator:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga7aed0a36c738169402404a3a5d54e43b">faceforward</a> (vec< L, T, Q > const &N, vec< L, T, Q > const &I, vec< L, T, Q > const &Nref)</td></tr>
- <tr class="memdesc:ga7aed0a36c738169402404a3a5d54e43b"><td class="mdescLeft"> </td><td class="mdescRight">If dot(Nref, I) < 0.0, return N, otherwise, return -N. <a href="a00897.html#ga7aed0a36c738169402404a3a5d54e43b">More...</a><br /></td></tr>
- <tr class="separator:ga7aed0a36c738169402404a3a5d54e43b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga0cdabbb000834d994a1d6dc56f8f5263">length</a> (vec< L, T, Q > const &x)</td></tr>
- <tr class="memdesc:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00897.html#ga0cdabbb000834d994a1d6dc56f8f5263">More...</a><br /></td></tr>
- <tr class="separator:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga3b8d3dcae77870781392ed2902cce597">normalize</a> (vec< L, T, Q > const &x)</td></tr>
- <tr class="memdesc:ga3b8d3dcae77870781392ed2902cce597"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1. <a href="a00897.html#ga3b8d3dcae77870781392ed2902cce597">More...</a><br /></td></tr>
- <tr class="separator:ga3b8d3dcae77870781392ed2902cce597"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga5631dd1d5618de5450b1ea3cf3e94905">reflect</a> (vec< L, T, Q > const &I, vec< L, T, Q > const &N)</td></tr>
- <tr class="memdesc:ga5631dd1d5618de5450b1ea3cf3e94905"><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="a00897.html#ga5631dd1d5618de5450b1ea3cf3e94905">More...</a><br /></td></tr>
- <tr class="separator:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
- <tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga01da3dff9e2ef6b9d4915c3047e22b74">refract</a> (vec< L, T, Q > const &I, vec< L, T, Q > const &N, T eta)</td></tr>
- <tr class="memdesc:ga01da3dff9e2ef6b9d4915c3047e22b74"><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="a00897.html#ga01da3dff9e2ef6b9d4915c3047e22b74">More...</a><br /></td></tr>
- <tr class="separator:ga01da3dff9e2ef6b9d4915c3047e22b74"><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="a00527.html" title="Core features">glm/geometric.hpp</a>> to use these core features. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="gaefe60743d7f415a33cbdddbe3bcf0258"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaefe60743d7f415a33cbdddbe3bcf0258">◆ </a></span>cross()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec<3, T, Q> glm::cross </td>
- <td>(</td>
- <td class="paramtype">vec< 3, T, Q > const & </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< 3, T, Q > 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 id="gaa68de6c53e20dfb2dac2d20197562e3f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaa68de6c53e20dfb2dac2d20197562e3f">◆ </a></span>distance()</h2>
- <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, Q > const & </td>
- <td class="paramname"><em>p0</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > 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 between 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 id="gaec50c25dd3b13834af0bf6fd2ce3931c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaec50c25dd3b13834af0bf6fd2ce3931c">◆ </a></span>dot()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR T glm::dot </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, Q > const & </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > 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 id="ga7aed0a36c738169402404a3a5d54e43b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga7aed0a36c738169402404a3a5d54e43b">◆ </a></span>faceforward()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::faceforward </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, Q > const & </td>
- <td class="paramname"><em>N</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > const & </td>
- <td class="paramname"><em>I</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > 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 id="ga0cdabbb000834d994a1d6dc56f8f5263"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0cdabbb000834d994a1d6dc56f8f5263">◆ </a></span>length()</h2>
- <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, Q > const & </td>
- <td class="paramname"><em>x</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>
- </div>
- </div>
- <a id="ga3b8d3dcae77870781392ed2902cce597"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga3b8d3dcae77870781392ed2902cce597">◆ </a></span>normalize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::normalize </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, Q > 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 id="ga5631dd1d5618de5450b1ea3cf3e94905"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga5631dd1d5618de5450b1ea3cf3e94905">◆ </a></span>reflect()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::reflect </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, Q > const & </td>
- <td class="paramname"><em>I</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > 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 id="ga01da3dff9e2ef6b9d4915c3047e22b74"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga01da3dff9e2ef6b9d4915c3047e22b74">◆ </a></span>refract()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::refract </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, Q > const & </td>
- <td class="paramname"><em>I</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, Q > 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>
- <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>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.18
- </small></address>
- </body>
- </html>
|