a00151.html 17 KB

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