a00131.html 16 KB

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