a00897.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.2 API documentation: Geometric functions</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.2 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Geometric functions<div class="ingroups"><a class="el" href="a00898.html">Core features</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaefe60743d7f415a33cbdddbe3bcf0258">cross</a> (vec&lt; 3, T, Q &gt; const &amp;x, vec&lt; 3, T, Q &gt; const &amp;y)</td></tr>
  74. <tr class="memdesc:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the cross product of x and y. <a href="a00897.html#gaefe60743d7f415a33cbdddbe3bcf0258">More...</a><br /></td></tr>
  75. <tr class="separator:gaefe60743d7f415a33cbdddbe3bcf0258"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaa68de6c53e20dfb2dac2d20197562e3f">distance</a> (vec&lt; L, T, Q &gt; const &amp;p0, vec&lt; L, T, Q &gt; const &amp;p1)</td></tr>
  78. <tr class="memdesc:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="mdescLeft">&#160;</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>
  79. <tr class="separator:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#gaec50c25dd3b13834af0bf6fd2ce3931c">dot</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
  82. <tr class="memdesc:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="mdescLeft">&#160;</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>
  83. <tr class="separator:gaec50c25dd3b13834af0bf6fd2ce3931c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga7aed0a36c738169402404a3a5d54e43b">faceforward</a> (vec&lt; L, T, Q &gt; const &amp;N, vec&lt; L, T, Q &gt; const &amp;I, vec&lt; L, T, Q &gt; const &amp;Nref)</td></tr>
  86. <tr class="memdesc:ga7aed0a36c738169402404a3a5d54e43b"><td class="mdescLeft">&#160;</td><td class="mdescRight">If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. <a href="a00897.html#ga7aed0a36c738169402404a3a5d54e43b">More...</a><br /></td></tr>
  87. <tr class="separator:ga7aed0a36c738169402404a3a5d54e43b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga0cdabbb000834d994a1d6dc56f8f5263">length</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  90. <tr class="memdesc:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00897.html#ga0cdabbb000834d994a1d6dc56f8f5263">More...</a><br /></td></tr>
  91. <tr class="separator:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  93. <tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga3b8d3dcae77870781392ed2902cce597">normalize</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  94. <tr class="memdesc:ga3b8d3dcae77870781392ed2902cce597"><td class="mdescLeft">&#160;</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>
  95. <tr class="separator:ga3b8d3dcae77870781392ed2902cce597"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  97. <tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga5631dd1d5618de5450b1ea3cf3e94905">reflect</a> (vec&lt; L, T, Q &gt; const &amp;I, vec&lt; L, T, Q &gt; const &amp;N)</td></tr>
  98. <tr class="memdesc:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="mdescLeft">&#160;</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>
  99. <tr class="separator:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  101. <tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00897.html#ga01da3dff9e2ef6b9d4915c3047e22b74">refract</a> (vec&lt; L, T, Q &gt; const &amp;I, vec&lt; L, T, Q &gt; const &amp;N, T eta)</td></tr>
  102. <tr class="memdesc:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="mdescLeft">&#160;</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>
  103. <tr class="separator:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table>
  105. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  106. <p>These operate on vectors as vectors, not component-wise.</p>
  107. <p>Include &lt;<a class="el" href="a00527.html" title="Core features">glm/geometric.hpp</a>&gt; to use these core features. </p>
  108. <h2 class="groupheader">Function Documentation</h2>
  109. <a id="gaefe60743d7f415a33cbdddbe3bcf0258"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#gaefe60743d7f415a33cbdddbe3bcf0258">&#9670;&nbsp;</a></span>cross()</h2>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;3, T, Q&gt; glm::cross </td>
  116. <td>(</td>
  117. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  118. <td class="paramname"><em>x</em>, </td>
  119. </tr>
  120. <tr>
  121. <td class="paramkey"></td>
  122. <td></td>
  123. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  124. <td class="paramname"><em>y</em>&#160;</td>
  125. </tr>
  126. <tr>
  127. <td></td>
  128. <td>)</td>
  129. <td></td><td></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Returns the cross product of x and y. </p>
  134. <dl class="tparams"><dt>Template Parameters</dt><dd>
  135. <table class="tparams">
  136. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  137. </table>
  138. </dd>
  139. </dl>
  140. <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>
  141. <dd>
  142. <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>
  143. </div>
  144. </div>
  145. <a id="gaa68de6c53e20dfb2dac2d20197562e3f"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#gaa68de6c53e20dfb2dac2d20197562e3f">&#9670;&nbsp;</a></span>distance()</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">GLM_FUNC_DECL T glm::distance </td>
  152. <td>(</td>
  153. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  154. <td class="paramname"><em>p0</em>, </td>
  155. </tr>
  156. <tr>
  157. <td class="paramkey"></td>
  158. <td></td>
  159. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  160. <td class="paramname"><em>p1</em>&#160;</td>
  161. </tr>
  162. <tr>
  163. <td></td>
  164. <td>)</td>
  165. <td></td><td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Returns the distance between p0 and p1, i.e., length(p0 - p1). </p>
  170. <dl class="tparams"><dt>Template Parameters</dt><dd>
  171. <table class="tparams">
  172. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  173. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  174. </table>
  175. </dd>
  176. </dl>
  177. <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>
  178. <dd>
  179. <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>
  180. </div>
  181. </div>
  182. <a id="gaec50c25dd3b13834af0bf6fd2ce3931c"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#gaec50c25dd3b13834af0bf6fd2ce3931c">&#9670;&nbsp;</a></span>dot()</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR T glm::dot </td>
  189. <td>(</td>
  190. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  191. <td class="paramname"><em>x</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  197. <td class="paramname"><em>y</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Returns the dot product of x and y, i.e., result = x * y. </p>
  207. <dl class="tparams"><dt>Template Parameters</dt><dd>
  208. <table class="tparams">
  209. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  210. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. <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>
  215. <dd>
  216. <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>
  217. </div>
  218. </div>
  219. <a id="ga7aed0a36c738169402404a3a5d54e43b"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#ga7aed0a36c738169402404a3a5d54e43b">&#9670;&nbsp;</a></span>faceforward()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::faceforward </td>
  226. <td>(</td>
  227. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  228. <td class="paramname"><em>N</em>, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  234. <td class="paramname"><em>I</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  240. <td class="paramname"><em>Nref</em>&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. </p>
  250. <dl class="tparams"><dt>Template Parameters</dt><dd>
  251. <table class="tparams">
  252. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  253. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  254. </table>
  255. </dd>
  256. </dl>
  257. <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>
  258. <dd>
  259. <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>
  260. </div>
  261. </div>
  262. <a id="ga0cdabbb000834d994a1d6dc56f8f5263"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#ga0cdabbb000834d994a1d6dc56f8f5263">&#9670;&nbsp;</a></span>length()</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">GLM_FUNC_DECL T glm::length </td>
  269. <td>(</td>
  270. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  271. <td class="paramname"><em>x</em></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Returns the length of x, i.e., sqrt(x * x). </p>
  277. <dl class="tparams"><dt>Template Parameters</dt><dd>
  278. <table class="tparams">
  279. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  280. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  281. </table>
  282. </dd>
  283. </dl>
  284. <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>
  285. <dd>
  286. <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>
  287. </div>
  288. </div>
  289. <a id="ga3b8d3dcae77870781392ed2902cce597"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#ga3b8d3dcae77870781392ed2902cce597">&#9670;&nbsp;</a></span>normalize()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::normalize </td>
  296. <td>(</td>
  297. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  298. <td class="paramname"><em>x</em></td><td>)</td>
  299. <td></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Returns a vector in the same direction as x but with length of 1. </p>
  304. <p>According to issue 10 GLSL 1.10 specification, if length(x) == 0 then result is undefined and generate an error.</p>
  305. <dl class="tparams"><dt>Template Parameters</dt><dd>
  306. <table class="tparams">
  307. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  308. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  309. </table>
  310. </dd>
  311. </dl>
  312. <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>
  313. <dd>
  314. <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>
  315. </div>
  316. </div>
  317. <a id="ga5631dd1d5618de5450b1ea3cf3e94905"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#ga5631dd1d5618de5450b1ea3cf3e94905">&#9670;&nbsp;</a></span>reflect()</h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::reflect </td>
  324. <td>(</td>
  325. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  326. <td class="paramname"><em>I</em>, </td>
  327. </tr>
  328. <tr>
  329. <td class="paramkey"></td>
  330. <td></td>
  331. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  332. <td class="paramname"><em>N</em>&#160;</td>
  333. </tr>
  334. <tr>
  335. <td></td>
  336. <td>)</td>
  337. <td></td><td></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. </p>
  342. <dl class="tparams"><dt>Template Parameters</dt><dd>
  343. <table class="tparams">
  344. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  345. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  346. </table>
  347. </dd>
  348. </dl>
  349. <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>
  350. <dd>
  351. <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>
  352. </div>
  353. </div>
  354. <a id="ga01da3dff9e2ef6b9d4915c3047e22b74"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#ga01da3dff9e2ef6b9d4915c3047e22b74">&#9670;&nbsp;</a></span>refract()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::refract </td>
  361. <td>(</td>
  362. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  363. <td class="paramname"><em>I</em>, </td>
  364. </tr>
  365. <tr>
  366. <td class="paramkey"></td>
  367. <td></td>
  368. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  369. <td class="paramname"><em>N</em>, </td>
  370. </tr>
  371. <tr>
  372. <td class="paramkey"></td>
  373. <td></td>
  374. <td class="paramtype">T&#160;</td>
  375. <td class="paramname"><em>eta</em>&#160;</td>
  376. </tr>
  377. <tr>
  378. <td></td>
  379. <td>)</td>
  380. <td></td><td></td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. </p>
  385. <dl class="tparams"><dt>Template Parameters</dt><dd>
  386. <table class="tparams">
  387. <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
  388. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  389. </table>
  390. </dd>
  391. </dl>
  392. <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>
  393. <dd>
  394. <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>
  395. </div>
  396. </div>
  397. </div><!-- contents -->
  398. <!-- start footer part -->
  399. <hr class="footer"/><address class="footer"><small>
  400. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  401. <img class="footer" src="doxygen.png" alt="doxygen"/>
  402. </a> 1.8.18
  403. </small></address>
  404. </body>
  405. </html>