Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.8.4
Branches Tags
glm
/
doc
/
html
/
a00129.html

a00129.html 15 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>GLM: glm::core::function::geometric Namespace Reference</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.6.1 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul>
    14. 

  14.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
    16. 

  16.       <li><a href="files.html"><span>Files</span></a></li>
    17. 

  17.     </ul>
    18. 

  18.   </div>
    19. 

  19.   <div class="tabs">
    20. 

  20.     <ul>
    21. 

  21.       <li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li>
    22. 

  22.       <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
    23. 

  23.     </ul>
    24. 

  24.   </div>
    25. 

  25.   <div class="navpath"><a class="el" href="a00124.html">glm</a>::<a class="el" href="a00125.html">core</a>::<a class="el" href="a00126.html">function</a>::<a class="el" href="a00129.html">geometric</a>
    26. 

  26.   </div>
    27. 

  27. </div>
    28. 

  28. <div class="contents">
    29. 

  29. <h1>glm::core::function::geometric Namespace Reference</h1>
    30. 

  30. <p>Define all <a class="el" href="a00129.html" title="Define all geometric functions from Section 8.4 of GLSL 1.30.8 specification. Included...">geometric</a> functions from Section 8.4 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace.  
    31. 

  31. <a href="#_details">More...</a></p>
    32. 

  32. <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33. <tr><td colspan="2"><h2>Functions</h2></td></tr>
    34. 

  34. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
    35. 

  35. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#aef2c634b57ee979caa2ab897b6960e1f">cross</a> (detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)</td></tr>
    36. 

  36. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the cross product of x and y.  <a href="#aef2c634b57ee979caa2ab897b6960e1f"></a><br/></td></tr>
    37. 

  37. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    38. 

  38. <tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#aa7cb6dbe9b8224c25345f1fd6fc09e77">distance</a> (genType const &amp;p0, genType const &amp;p1)</td></tr>
    39. 

  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1).  <a href="#aa7cb6dbe9b8224c25345f1fd6fc09e77"></a><br/></td></tr>
    40. 

  40. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    41. 

  41. <tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#a38e1f1538ac0fedc9d6ac14910105421">dot</a> (genType const &amp;x, genType const &amp;y)</td></tr>
    42. 

  42. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y.  <a href="#a38e1f1538ac0fedc9d6ac14910105421"></a><br/></td></tr>
    43. 

  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    44. 

  44. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#ad591e8f7b1a5e311d3439dda2bb82aea">faceforward</a> (genType const &amp;N, genType const &amp;I, genType const &amp;Nref)</td></tr>
    45. 

  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N.  <a href="#ad591e8f7b1a5e311d3439dda2bb82aea"></a><br/></td></tr>
    46. 

  46. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    47. 

  47. <tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#a10ee9a1d18c6da61cab61d8637d23847">length</a> (genType const &amp;x)</td></tr>
    48. 

  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x).  <a href="#a10ee9a1d18c6da61cab61d8637d23847"></a><br/></td></tr>
    49. 

  49. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    50. 

  50. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#a07ff16965f11fa17122ac874ed492276">normalize</a> (genType const &amp;x)</td></tr>
    51. 

  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1.  <a href="#a07ff16965f11fa17122ac874ed492276"></a><br/></td></tr>
    52. 

  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    53. 

  53. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#a2863d2331eb3752a5a17244c604c1d07">reflect</a> (genType const &amp;I, genType const &amp;N)</td></tr>
    54. 

  54. <tr><td class="mdescLeft">&nbsp;</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="#a2863d2331eb3752a5a17244c604c1d07"></a><br/></td></tr>
    55. 

  55. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    56. 

  56. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00129.html#a895392ad98499a450e2cc8579d76a84d">refract</a> (genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)</td></tr>
    57. 

  57. <tr><td class="mdescLeft">&nbsp;</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="#a895392ad98499a450e2cc8579d76a84d"></a><br/></td></tr>
    58. 

  58. </table>
    59. 

  59. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    60. 

  60. <p>Define all <a class="el" href="a00129.html" title="Define all geometric functions from Section 8.4 of GLSL 1.30.8 specification. Included...">geometric</a> functions from Section 8.4 of GLSL 1.30.8 specification. Included in <a class="el" href="a00124.html" title="GLM namespace, it contains all GLSL based features.">glm</a> namespace. </p>
    61. 

  61. <hr/><h2>Function Documentation</h2>
    62. 

  62. <a class="anchor" id="aef2c634b57ee979caa2ab897b6960e1f"></a><!-- doxytag: member="glm::core::function::geometric::cross" ref="aef2c634b57ee979caa2ab897b6960e1f" args="(detail::tvec3&lt; valType &gt; const &amp;x, detail::tvec3&lt; valType &gt; const &amp;y)" -->
    63. 

  63. <div class="memitem">
    64. 

  64. <div class="memproto">
    65. 

  65.       <table class="memname">
    66. 

  66.         <tr>
    67. 

  67.           <td class="memname">detail::tvec3&lt;valType&gt; glm::core::function::geometric::cross </td>
    68. 

  68.           <td>(</td>
    69. 

  69.           <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&nbsp;</td>
    70. 

  70.           <td class="paramname"> <em>x</em>, </td>
    71. 

  71.         </tr>
    72. 

  72.         <tr>
    73. 

  73.           <td class="paramkey"></td>
    74. 

  74.           <td></td>
    75. 

  75.           <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&nbsp;</td>
    76. 

  76.           <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
    77. 

  77.         </tr>
    78. 

  78.         <tr>
    79. 

  79.           <td></td>
    80. 

  80.           <td>)</td>
    81. 

  81.           <td></td><td></td><td></td>
    82. 

  82.         </tr>
    83. 

  83.       </table>
    84. 

  84. </div>
    85. 

  85. <div class="memdoc">
    86. 

  86. 

  87. <p>Returns the cross product of x and y. </p>
    88. 

  88. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    89. 

  89. 

  90. </div>
    91. 

  91. </div>
    92. 

  92. <a class="anchor" id="aa7cb6dbe9b8224c25345f1fd6fc09e77"></a><!-- doxytag: member="glm::core::function::geometric::distance" ref="aa7cb6dbe9b8224c25345f1fd6fc09e77" args="(genType const &amp;p0, genType const &amp;p1)" -->
    93. 

  93. <div class="memitem">
    94. 

  94. <div class="memproto">
    95. 

  95.       <table class="memname">
    96. 

  96.         <tr>
    97. 

  97.           <td class="memname">genType::value_type glm::core::function::geometric::distance </td>
    98. 

  98.           <td>(</td>
    99. 

  99.           <td class="paramtype">genType const &amp;&nbsp;</td>
    100. 

  100.           <td class="paramname"> <em>p0</em>, </td>
    101. 

  101.         </tr>
    102. 

  102.         <tr>
    103. 

  103.           <td class="paramkey"></td>
    104. 

  104.           <td></td>
    105. 

  105.           <td class="paramtype">genType const &amp;&nbsp;</td>
    106. 

  106.           <td class="paramname"> <em>p1</em></td><td>&nbsp;</td>
    107. 

  107.         </tr>
    108. 

  108.         <tr>
    109. 

  109.           <td></td>
    110. 

  110.           <td>)</td>
    111. 

  111.           <td></td><td></td><td></td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

  114. </div>
    115. 

  115. <div class="memdoc">
    116. 

  116. 

  117. <p>Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </p>
    118. 

  118. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    119. 

  119. 

  120. </div>
    121. 

  121. </div>
    122. 

  122. <a class="anchor" id="a38e1f1538ac0fedc9d6ac14910105421"></a><!-- doxytag: member="glm::core::function::geometric::dot" ref="a38e1f1538ac0fedc9d6ac14910105421" args="(genType const &amp;x, genType const &amp;y)" -->
    123. 

  123. <div class="memitem">
    124. 

  124. <div class="memproto">
    125. 

  125.       <table class="memname">
    126. 

  126.         <tr>
    127. 

  127.           <td class="memname">genType::value_type glm::core::function::geometric::dot </td>
    128. 

  128.           <td>(</td>
    129. 

  129.           <td class="paramtype">genType const &amp;&nbsp;</td>
    130. 

  130.           <td class="paramname"> <em>x</em>, </td>
    131. 

  131.         </tr>
    132. 

  132.         <tr>
    133. 

  133.           <td class="paramkey"></td>
    134. 

  134.           <td></td>
    135. 

  135.           <td class="paramtype">genType const &amp;&nbsp;</td>
    136. 

  136.           <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
    137. 

  137.         </tr>
    138. 

  138.         <tr>
    139. 

  139.           <td></td>
    140. 

  140.           <td>)</td>
    141. 

  141.           <td></td><td></td><td></td>
    142. 

  142.         </tr>
    143. 

  143.       </table>
    144. 

  144. </div>
    145. 

  145. <div class="memdoc">
    146. 

  146. 

  147. <p>Returns the dot product of x and y, i.e., result = x * y. </p>
    148. 

  148. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    149. 

  149. 

  150. </div>
    151. 

  151. </div>
    152. 

  152. <a class="anchor" id="ad591e8f7b1a5e311d3439dda2bb82aea"></a><!-- doxytag: member="glm::core::function::geometric::faceforward" ref="ad591e8f7b1a5e311d3439dda2bb82aea" args="(genType const &amp;N, genType const &amp;I, genType const &amp;Nref)" -->
    153. 

  153. <div class="memitem">
    154. 

  154. <div class="memproto">
    155. 

  155.       <table class="memname">
    156. 

  156.         <tr>
    157. 

  157.           <td class="memname">genType glm::core::function::geometric::faceforward </td>
    158. 

  158.           <td>(</td>
    159. 

  159.           <td class="paramtype">genType const &amp;&nbsp;</td>
    160. 

  160.           <td class="paramname"> <em>N</em>, </td>
    161. 

  161.         </tr>
    162. 

  162.         <tr>
    163. 

  163.           <td class="paramkey"></td>
    164. 

  164.           <td></td>
    165. 

  165.           <td class="paramtype">genType const &amp;&nbsp;</td>
    166. 

  166.           <td class="paramname"> <em>I</em>, </td>
    167. 

  167.         </tr>
    168. 

  168.         <tr>
    169. 

  169.           <td class="paramkey"></td>
    170. 

  170.           <td></td>
    171. 

  171.           <td class="paramtype">genType const &amp;&nbsp;</td>
    172. 

  172.           <td class="paramname"> <em>Nref</em></td><td>&nbsp;</td>
    173. 

  173.         </tr>
    174. 

  174.         <tr>
    175. 

  175.           <td></td>
    176. 

  176.           <td>)</td>
    177. 

  177.           <td></td><td></td><td></td>
    178. 

  178.         </tr>
    179. 

  179.       </table>
    180. 

  180. </div>
    181. 

  181. <div class="memdoc">
    182. 

  182. 

  183. <p>If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. </p>
    184. 

  184. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    185. 

  185. 

  186. </div>
    187. 

  187. </div>
    188. 

  188. <a class="anchor" id="a10ee9a1d18c6da61cab61d8637d23847"></a><!-- doxytag: member="glm::core::function::geometric::length" ref="a10ee9a1d18c6da61cab61d8637d23847" args="(genType const &amp;x)" -->
    189. 

  189. <div class="memitem">
    190. 

  190. <div class="memproto">
    191. 

  191.       <table class="memname">
    192. 

  192.         <tr>
    193. 

  193.           <td class="memname">genType::value_type glm::core::function::geometric::length </td>
    194. 

  194.           <td>(</td>
    195. 

  195.           <td class="paramtype">genType const &amp;&nbsp;</td>
    196. 

  196.           <td class="paramname"> <em>x</em></td>
    197. 

  197.           <td>&nbsp;)&nbsp;</td>
    198. 

  198.           <td></td>
    199. 

  199.         </tr>
    200. 

  200.       </table>
    201. 

  201. </div>
    202. 

  202. <div class="memdoc">
    203. 

  203. 

  204. <p>Returns the length of x, i.e., sqrt(x * x). </p>
    205. 

  205. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    206. 

  206. 

  207. </div>
    208. 

  208. </div>
    209. 

  209. <a class="anchor" id="a07ff16965f11fa17122ac874ed492276"></a><!-- doxytag: member="glm::core::function::geometric::normalize" ref="a07ff16965f11fa17122ac874ed492276" args="(genType const &amp;x)" -->
    210. 

  210. <div class="memitem">
    211. 

  211. <div class="memproto">
    212. 

  212.       <table class="memname">
    213. 

  213.         <tr>
    214. 

  214.           <td class="memname">genType glm::core::function::geometric::normalize </td>
    215. 

  215.           <td>(</td>
    216. 

  216.           <td class="paramtype">genType const &amp;&nbsp;</td>
    217. 

  217.           <td class="paramname"> <em>x</em></td>
    218. 

  218.           <td>&nbsp;)&nbsp;</td>
    219. 

  219.           <td></td>
    220. 

  220.         </tr>
    221. 

  221.       </table>
    222. 

  222. </div>
    223. 

  223. <div class="memdoc">
    224. 

  224. 

  225. <p>Returns a vector in the same direction as x but with length of 1. </p>
    226. 

  226. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    227. 

  227. 

  228. </div>
    229. 

  229. </div>
    230. 

  230. <a class="anchor" id="a2863d2331eb3752a5a17244c604c1d07"></a><!-- doxytag: member="glm::core::function::geometric::reflect" ref="a2863d2331eb3752a5a17244c604c1d07" args="(genType const &amp;I, genType const &amp;N)" -->
    231. 

  231. <div class="memitem">
    232. 

  232. <div class="memproto">
    233. 

  233.       <table class="memname">
    234. 

  234.         <tr>
    235. 

  235.           <td class="memname">genType glm::core::function::geometric::reflect </td>
    236. 

  236.           <td>(</td>
    237. 

  237.           <td class="paramtype">genType const &amp;&nbsp;</td>
    238. 

  238.           <td class="paramname"> <em>I</em>, </td>
    239. 

  239.         </tr>
    240. 

  240.         <tr>
    241. 

  241.           <td class="paramkey"></td>
    242. 

  242.           <td></td>
    243. 

  243.           <td class="paramtype">genType const &amp;&nbsp;</td>
    244. 

  244.           <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
    245. 

  245.         </tr>
    246. 

  246.         <tr>
    247. 

  247.           <td></td>
    248. 

  248.           <td>)</td>
    249. 

  249.           <td></td><td></td><td></td>
    250. 

  250.         </tr>
    251. 

  251.       </table>
    252. 

  252. </div>
    253. 

  253. <div class="memdoc">
    254. 

  254. 

  255. <p>For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. </p>
    256. 

  256. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    257. 

  257. 

  258. </div>
    259. 

  259. </div>
    260. 

  260. <a class="anchor" id="a895392ad98499a450e2cc8579d76a84d"></a><!-- doxytag: member="glm::core::function::geometric::refract" ref="a895392ad98499a450e2cc8579d76a84d" args="(genType const &amp;I, genType const &amp;N, typename genType::value_type const &amp;eta)" -->
    261. 

  261. <div class="memitem">
    262. 

  262. <div class="memproto">
    263. 

  263.       <table class="memname">
    264. 

  264.         <tr>
    265. 

  265.           <td class="memname">genType glm::core::function::geometric::refract </td>
    266. 

  266.           <td>(</td>
    267. 

  267.           <td class="paramtype">genType const &amp;&nbsp;</td>
    268. 

  268.           <td class="paramname"> <em>I</em>, </td>
    269. 

  269.         </tr>
    270. 

  270.         <tr>
    271. 

  271.           <td class="paramkey"></td>
    272. 

  272.           <td></td>
    273. 

  273.           <td class="paramtype">genType const &amp;&nbsp;</td>
    274. 

  274.           <td class="paramname"> <em>N</em>, </td>
    275. 

  275.         </tr>
    276. 

  276.         <tr>
    277. 

  277.           <td class="paramkey"></td>
    278. 

  278.           <td></td>
    279. 

  279.           <td class="paramtype">typename genType::value_type const &amp;&nbsp;</td>
    280. 

  280.           <td class="paramname"> <em>eta</em></td><td>&nbsp;</td>
    281. 

  281.         </tr>
    282. 

  282.         <tr>
    283. 

  283.           <td></td>
    284. 

  284.           <td>)</td>
    285. 

  285.           <td></td><td></td><td></td>
    286. 

  286.         </tr>
    287. 

  287.       </table>
    288. 

  288. </div>
    289. 

  289. <div class="memdoc">
    290. 

  290. 

  291. <p>For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. </p>
    292. 

  292. <p>(From GLSL 1.30.08 specification, section 8.4) </p>
    293. 

  293. 

  294. </div>
    295. 

  295. </div>
    296. 

  296. </div>
    297. 

  297. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
    298. 

  298. <a href="http://www.doxygen.org/index.html">
    299. 

  299. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
    300. 

  300. </body>
    301. 

  301. </html>
    302.