a00147.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
  7. <title>0.9.8 API documenation: Geometric functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.8 API documenation
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">Geometric functions<div class="ingroups"><a class="el" href="a00155.html">GLM Core</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <p>These operate on vectors as vectors, not component-wise.
  46. <a href="#details">More...</a></p>
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  51. <tr class="memitem:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gafe2cae8cb26fd44be62aee97369d0af8">cross</a> (tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y)</td></tr>
  52. <tr class="memdesc:gafe2cae8cb26fd44be62aee97369d0af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the cross product of x and y. <a href="a00147.html#gafe2cae8cb26fd44be62aee97369d0af8">More...</a><br /></td></tr>
  53. <tr class="separator:gafe2cae8cb26fd44be62aee97369d0af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  55. <tr class="memitem:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga7ca317dde0d7e94d920153554d4a02a8">distance</a> (vecType&lt; T, P &gt; const &amp;p0, vecType&lt; T, P &gt; const &amp;p1)</td></tr>
  56. <tr class="memdesc:ga7ca317dde0d7e94d920153554d4a02a8"><td class="mdescLeft">&#160;</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>
  57. <tr class="separator:ga7ca317dde0d7e94d920153554d4a02a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  59. <tr class="memitem:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
  60. <tr class="memdesc:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="mdescLeft">&#160;</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>
  61. <tr class="separator:ga7dada304da2ba7dd3376ab4f178c3f6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  63. <tr class="memitem:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">faceforward</a> (vecType&lt; T, P &gt; const &amp;N, vecType&lt; T, P &gt; const &amp;I, vecType&lt; T, P &gt; const &amp;Nref)</td></tr>
  64. <tr class="memdesc:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. <a href="a00147.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">More...</a><br /></td></tr>
  65. <tr class="separator:gaea854e5aec1b5839832ac2dfc7cd3c0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  67. <tr class="memitem:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga18d45e3d4c7705e67ccfabd99e521604">length</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  68. <tr class="memdesc:ga18d45e3d4c7705e67ccfabd99e521604"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00147.html#ga18d45e3d4c7705e67ccfabd99e521604">More...</a><br /></td></tr>
  69. <tr class="separator:ga18d45e3d4c7705e67ccfabd99e521604"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:gada9451ec170a36fe53552812b9c03a68"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  71. <tr class="memitem:gada9451ec170a36fe53552812b9c03a68"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gada9451ec170a36fe53552812b9c03a68">normalize</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  72. <tr class="memdesc:gada9451ec170a36fe53552812b9c03a68"><td class="mdescLeft">&#160;</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>
  73. <tr class="separator:gada9451ec170a36fe53552812b9c03a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  75. <tr class="memitem:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a> (genType const &amp;I, genType const &amp;N)</td></tr>
  76. <tr class="memdesc:gab63646fc36b81cf69d3ce123a72f76f2"><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="a00147.html#gab63646fc36b81cf69d3ce123a72f76f2">More...</a><br /></td></tr>
  77. <tr class="separator:gab63646fc36b81cf69d3ce123a72f76f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  79. <tr class="memitem:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gab7e7cdf4403931a5f7b74560ad64159b">refract</a> (vecType&lt; T, P &gt; const &amp;I, vecType&lt; T, P &gt; const &amp;N, T eta)</td></tr>
  80. <tr class="memdesc:gab7e7cdf4403931a5f7b74560ad64159b"><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="a00147.html#gab7e7cdf4403931a5f7b74560ad64159b">More...</a><br /></td></tr>
  81. <tr class="separator:gab7e7cdf4403931a5f7b74560ad64159b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. </table>
  83. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  84. <p>These operate on vectors as vectors, not component-wise. </p>
  85. <h2 class="groupheader">Function Documentation</h2>
  86. <a class="anchor" id="gafe2cae8cb26fd44be62aee97369d0af8"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::cross </td>
  92. <td>(</td>
  93. <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
  94. <td class="paramname"><em>x</em>, </td>
  95. </tr>
  96. <tr>
  97. <td class="paramkey"></td>
  98. <td></td>
  99. <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
  100. <td class="paramname"><em>y</em>&#160;</td>
  101. </tr>
  102. <tr>
  103. <td></td>
  104. <td>)</td>
  105. <td></td><td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. <p>Returns the cross product of x and y. </p>
  110. <dl class="tparams"><dt>Template Parameters</dt><dd>
  111. <table class="tparams">
  112. <tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
  113. </table>
  114. </dd>
  115. </dl>
  116. <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>
  117. <dd>
  118. <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>
  119. </div>
  120. </div>
  121. <a class="anchor" id="ga7ca317dde0d7e94d920153554d4a02a8"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">GLM_FUNC_DECL T glm::distance </td>
  127. <td>(</td>
  128. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  129. <td class="paramname"><em>p0</em>, </td>
  130. </tr>
  131. <tr>
  132. <td class="paramkey"></td>
  133. <td></td>
  134. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  135. <td class="paramname"><em>p1</em>&#160;</td>
  136. </tr>
  137. <tr>
  138. <td></td>
  139. <td>)</td>
  140. <td></td><td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </p>
  145. <dl class="tparams"><dt>Template Parameters</dt><dd>
  146. <table class="tparams">
  147. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  148. </table>
  149. </dd>
  150. </dl>
  151. <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>
  152. <dd>
  153. <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>
  154. </div>
  155. </div>
  156. <a class="anchor" id="ga7dada304da2ba7dd3376ab4f178c3f6b"></a>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">GLM_FUNC_DECL T glm::dot </td>
  162. <td>(</td>
  163. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  164. <td class="paramname"><em>x</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  170. <td class="paramname"><em>y</em>&#160;</td>
  171. </tr>
  172. <tr>
  173. <td></td>
  174. <td>)</td>
  175. <td></td><td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Returns the dot product of x and y, i.e., result = x * y. </p>
  180. <dl class="tparams"><dt>Template Parameters</dt><dd>
  181. <table class="tparams">
  182. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <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>
  187. <dd>
  188. <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>
  189. </div>
  190. </div>
  191. <a class="anchor" id="gaea854e5aec1b5839832ac2dfc7cd3c0d"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::faceforward </td>
  197. <td>(</td>
  198. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  199. <td class="paramname"><em>N</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  205. <td class="paramname"><em>I</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  211. <td class="paramname"><em>Nref</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. </p>
  221. <dl class="tparams"><dt>Template Parameters</dt><dd>
  222. <table class="tparams">
  223. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  224. </table>
  225. </dd>
  226. </dl>
  227. <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>
  228. <dd>
  229. <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>
  230. </div>
  231. </div>
  232. <a class="anchor" id="ga18d45e3d4c7705e67ccfabd99e521604"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">GLM_FUNC_DECL T glm::length </td>
  238. <td>(</td>
  239. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  240. <td class="paramname"><em>x</em></td><td>)</td>
  241. <td></td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Returns the length of x, i.e., sqrt(x * x). </p>
  246. <dl class="tparams"><dt>Template Parameters</dt><dd>
  247. <table class="tparams">
  248. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  249. </table>
  250. </dd>
  251. </dl>
  252. <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>
  253. <dd>
  254. <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>
  255. </div>
  256. </div>
  257. <a class="anchor" id="gada9451ec170a36fe53552812b9c03a68"></a>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::normalize </td>
  263. <td>(</td>
  264. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  265. <td class="paramname"><em>x</em></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>Returns a vector in the same direction as x but with length of 1. </p>
  271. <p>According to issue 10 GLSL 1.10 specification, if length(x) == 0 then result is undefined and generate an error.</p>
  272. <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>
  273. <dd>
  274. <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>
  275. </div>
  276. </div>
  277. <a class="anchor" id="gab63646fc36b81cf69d3ce123a72f76f2"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">GLM_FUNC_DECL genType glm::reflect </td>
  283. <td>(</td>
  284. <td class="paramtype">genType const &amp;&#160;</td>
  285. <td class="paramname"><em>I</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">genType const &amp;&#160;</td>
  291. <td class="paramname"><em>N</em>&#160;</td>
  292. </tr>
  293. <tr>
  294. <td></td>
  295. <td>)</td>
  296. <td></td><td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. </p>
  301. <dl class="tparams"><dt>Template Parameters</dt><dd>
  302. <table class="tparams">
  303. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  304. </table>
  305. </dd>
  306. </dl>
  307. <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>
  308. <dd>
  309. <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>
  310. </div>
  311. </div>
  312. <a class="anchor" id="gab7e7cdf4403931a5f7b74560ad64159b"></a>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::refract </td>
  318. <td>(</td>
  319. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  320. <td class="paramname"><em>I</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  326. <td class="paramname"><em>N</em>, </td>
  327. </tr>
  328. <tr>
  329. <td class="paramkey"></td>
  330. <td></td>
  331. <td class="paramtype">T&#160;</td>
  332. <td class="paramname"><em>eta</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 normal N, and the ratio of indices of refraction eta, return the refraction vector. </p>
  342. <dl class="tparams"><dt>Template Parameters</dt><dd>
  343. <table class="tparams">
  344. <tr><td class="paramname">genType</td><td>Floating-point vector types.</td></tr>
  345. </table>
  346. </dd>
  347. </dl>
  348. <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>
  349. <dd>
  350. <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>
  351. </div>
  352. </div>
  353. </div><!-- contents -->
  354. <!-- start footer part -->
  355. <hr class="footer"/><address class="footer"><small>
  356. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  357. <img class="footer" src="doxygen.png" alt="doxygen"/>
  358. </a> 1.8.10
  359. </small></address>
  360. </body>
  361. </html>