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.9.8
Branches Tags
glm
/
doc
/
api
/
a00211.html

a00211.html 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293 
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.10"/>
    7. 

  7. <title>0.9.8: GLM_GTX_norm</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    15. 

  15. <div id="titlearea">
    16. 

  16. <table cellspacing="0" cellpadding="0">
    17. 

  17.  <tbody>
    18. 

  18.  <tr style="height: 56px;">
    19. 

  19.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    20. 

  20.   <td id="projectalign" style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">0.9.8
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.10 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="files.html"><span>Files</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37. </div><!-- top -->
    38. 

  38. <div class="header">
    39. 

  39.   <div class="summary">
    40. 

  40. <a href="#func-members">Functions</a>  </div>
    41. 

  41.   <div class="headertitle">
    42. 

  42. <div class="title">GLM_GTX_norm<div class="ingroups"><a class="el" href="a00155.html">GTX Extensions (Experimental)</a></div></div>  </div>
    43. 

  43. </div><!--header-->
    44. 

  44. <div class="contents">
    45. 

  45. <table class="memberdecls">
    46. 

  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    47. 

  47. Functions</h2></td></tr>
    48. 

  48. <tr class="memitem:ga647d2602008801d6ed78f9708eb439cc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
    49. 

  49. <tr class="memitem:ga647d2602008801d6ed78f9708eb439cc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga647d2602008801d6ed78f9708eb439cc">distance2</a> (vecType&lt; T, P &gt; const &amp;p0, vecType&lt; T, P &gt; const &amp;p1)</td></tr>
    50. 

  50. <tr class="separator:ga647d2602008801d6ed78f9708eb439cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    51. 

  51. <tr class="memitem:gaebe5a39b06e262e615622129f37da4f4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    52. 

  52. <tr class="memitem:gaebe5a39b06e262e615622129f37da4f4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gaebe5a39b06e262e615622129f37da4f4">l1Norm</a> (tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y)</td></tr>
    53. 

  53. <tr class="separator:gaebe5a39b06e262e615622129f37da4f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    54. 

  54. <tr class="memitem:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    55. 

  55. <tr class="memitem:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
    56. 

  56. <tr class="separator:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    57. 

  57. <tr class="memitem:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    58. 

  58. <tr class="memitem:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gafa6fbbc99cd44d81bf030e74eaf7ad64">l2Norm</a> (tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y)</td></tr>
    59. 

  59. <tr class="separator:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memSeparator" colspan="2">&#160;</td></tr>
    60. 

  60. <tr class="memitem:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    61. 

  61. <tr class="memitem:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a> (tvec3&lt; T, P &gt; const &amp;x)</td></tr>
    62. 

  62. <tr class="separator:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memSeparator" colspan="2">&#160;</td></tr>
    63. 

  63. <tr class="memitem:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
    64. 

  64. <tr class="memitem:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga6d326d62fd9b7f4f0a1b79e56492a7e4">length2</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
    65. 

  65. <tr class="separator:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    66. 

  66. <tr class="memitem:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    67. 

  67. <tr class="memitem:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga932bb0854e5c5a6ab5a14b023c451ca7">lxNorm</a> (tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y, unsigned int Depth)</td></tr>
    68. 

  68. <tr class="separator:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    69. 

  69. <tr class="memitem:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
    70. 

  70. <tr class="memitem:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a> (tvec3&lt; T, P &gt; const &amp;x, unsigned int Depth)</td></tr>
    71. 

  71. <tr class="separator:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    72. 

  72. </table>
    73. 

  73. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    74. 

  74. <p>Various ways to compute vector norms. </p>
    75. 

  75. <p>&lt;<a class="el" href="a00074.html" title="GLM_GTX_norm ">glm/gtx/norm.hpp</a>&gt; need to be included to use these functionalities. </p>
    76. 

  76. <h2 class="groupheader">Function Documentation</h2>
    77. 

  77. <a class="anchor" id="ga647d2602008801d6ed78f9708eb439cc"></a>
    78. 

  78. <div class="memitem">
    79. 

  79. <div class="memproto">
    80. 

  80.       <table class="memname">
    81. 

  81.         <tr>
    82. 

  82.           <td class="memname">GLM_FUNC_DECL T glm::distance2 </td>
    83. 

  83.           <td>(</td>
    84. 

  84.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    85. 

  85.           <td class="paramname"><em>p0</em>, </td>
    86. 

  86.         </tr>
    87. 

  87.         <tr>
    88. 

  88.           <td class="paramkey"></td>
    89. 

  89.           <td></td>
    90. 

  90.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    91. 

  91.           <td class="paramname"><em>p1</em>&#160;</td>
    92. 

  92.         </tr>
    93. 

  93.         <tr>
    94. 

  94.           <td></td>
    95. 

  95.           <td>)</td>
    96. 

  96.           <td></td><td></td>
    97. 

  97.         </tr>
    98. 

  98.       </table>
    99. 

  99. </div><div class="memdoc">
    100. 

  100. 

  101. <p>Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). </p>
    102. 

  102. <p>From GLM_GTX_norm extension. </p>
    103. 

  103. 

  104. </div>
    105. 

  105. </div>
    106. 

  106. <a class="anchor" id="gaebe5a39b06e262e615622129f37da4f4"></a>
    107. 

  107. <div class="memitem">
    108. 

  108. <div class="memproto">
    109. 

  109.       <table class="memname">
    110. 

  110.         <tr>
    111. 

  111.           <td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
    112. 

  112.           <td>(</td>
    113. 

  113.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    114. 

  114.           <td class="paramname"><em>x</em>, </td>
    115. 

  115.         </tr>
    116. 

  116.         <tr>
    117. 

  117.           <td class="paramkey"></td>
    118. 

  118.           <td></td>
    119. 

  119.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    120. 

  120.           <td class="paramname"><em>y</em>&#160;</td>
    121. 

  121.         </tr>
    122. 

  122.         <tr>
    123. 

  123.           <td></td>
    124. 

  124.           <td>)</td>
    125. 

  125.           <td></td><td></td>
    126. 

  126.         </tr>
    127. 

  127.       </table>
    128. 

  128. </div><div class="memdoc">
    129. 

  129. 

  130. <p>Returns the L1 norm between x and y. </p>
    131. 

  131. <p>From GLM_GTX_norm extension. </p>
    132. 

  132. 

  133. </div>
    134. 

  134. </div>
    135. 

  135. <a class="anchor" id="ga6d5964f09cdb43803496a5ee3ced71cb"></a>
    136. 

  136. <div class="memitem">
    137. 

  137. <div class="memproto">
    138. 

  138.       <table class="memname">
    139. 

  139.         <tr>
    140. 

  140.           <td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
    141. 

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

  142.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    143. 

  143.           <td class="paramname"><em>v</em></td><td>)</td>
    144. 

  144.           <td></td>
    145. 

  145.         </tr>
    146. 

  146.       </table>
    147. 

  147. </div><div class="memdoc">
    148. 

  148. 

  149. <p>Returns the L1 norm of v. </p>
    150. 

  150. <p>From GLM_GTX_norm extension. </p>
    151. 

  151. 

  152. </div>
    153. 

  153. </div>
    154. 

  154. <a class="anchor" id="gafa6fbbc99cd44d81bf030e74eaf7ad64"></a>
    155. 

  155. <div class="memitem">
    156. 

  156. <div class="memproto">
    157. 

  157.       <table class="memname">
    158. 

  158.         <tr>
    159. 

  159.           <td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
    160. 

  160.           <td>(</td>
    161. 

  161.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    162. 

  162.           <td class="paramname"><em>x</em>, </td>
    163. 

  163.         </tr>
    164. 

  164.         <tr>
    165. 

  165.           <td class="paramkey"></td>
    166. 

  166.           <td></td>
    167. 

  167.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    168. 

  168.           <td class="paramname"><em>y</em>&#160;</td>
    169. 

  169.         </tr>
    170. 

  170.         <tr>
    171. 

  171.           <td></td>
    172. 

  172.           <td>)</td>
    173. 

  173.           <td></td><td></td>
    174. 

  174.         </tr>
    175. 

  175.       </table>
    176. 

  176. </div><div class="memdoc">
    177. 

  177. 

  178. <p>Returns the L2 norm between x and y. </p>
    179. 

  179. <p>From GLM_GTX_norm extension. </p>
    180. 

  180. 

  181. </div>
    182. 

  182. </div>
    183. 

  183. <a class="anchor" id="ga0a8cb8a0ce88d1d977de23209bf04610"></a>
    184. 

  184. <div class="memitem">
    185. 

  185. <div class="memproto">
    186. 

  186.       <table class="memname">
    187. 

  187.         <tr>
    188. 

  188.           <td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
    189. 

  189.           <td>(</td>
    190. 

  190.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    191. 

  191.           <td class="paramname"><em>x</em></td><td>)</td>
    192. 

  192.           <td></td>
    193. 

  193.         </tr>
    194. 

  194.       </table>
    195. 

  195. </div><div class="memdoc">
    196. 

  196. 

  197. <p>Returns the L2 norm of v. </p>
    198. 

  198. <p>From GLM_GTX_norm extension. </p>
    199. 

  199. 

  200. </div>
    201. 

  201. </div>
    202. 

  202. <a class="anchor" id="ga6d326d62fd9b7f4f0a1b79e56492a7e4"></a>
    203. 

  203. <div class="memitem">
    204. 

  204. <div class="memproto">
    205. 

  205.       <table class="memname">
    206. 

  206.         <tr>
    207. 

  207.           <td class="memname">GLM_FUNC_DECL T glm::length2 </td>
    208. 

  208.           <td>(</td>
    209. 

  209.           <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
    210. 

  210.           <td class="paramname"><em>x</em></td><td>)</td>
    211. 

  211.           <td></td>
    212. 

  212.         </tr>
    213. 

  213.       </table>
    214. 

  214. </div><div class="memdoc">
    215. 

  215. 

  216. <p>Returns the squared length of x. </p>
    217. 

  217. <p>From GLM_GTX_norm extension. </p>
    218. 

  218. 

  219. </div>
    220. 

  220. </div>
    221. 

  221. <a class="anchor" id="ga932bb0854e5c5a6ab5a14b023c451ca7"></a>
    222. 

  222. <div class="memitem">
    223. 

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

  224.       <table class="memname">
    225. 

  225.         <tr>
    226. 

  226.           <td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
    227. 

  227.           <td>(</td>
    228. 

  228.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    229. 

  229.           <td class="paramname"><em>x</em>, </td>
    230. 

  230.         </tr>
    231. 

  231.         <tr>
    232. 

  232.           <td class="paramkey"></td>
    233. 

  233.           <td></td>
    234. 

  234.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    235. 

  235.           <td class="paramname"><em>y</em>, </td>
    236. 

  236.         </tr>
    237. 

  237.         <tr>
    238. 

  238.           <td class="paramkey"></td>
    239. 

  239.           <td></td>
    240. 

  240.           <td class="paramtype">unsigned int&#160;</td>
    241. 

  241.           <td class="paramname"><em>Depth</em>&#160;</td>
    242. 

  242.         </tr>
    243. 

  243.         <tr>
    244. 

  244.           <td></td>
    245. 

  245.           <td>)</td>
    246. 

  246.           <td></td><td></td>
    247. 

  247.         </tr>
    248. 

  248.       </table>
    249. 

  249. </div><div class="memdoc">
    250. 

  250. 

  251. <p>Returns the L norm between x and y. </p>
    252. 

  252. <p>From GLM_GTX_norm extension. </p>
    253. 

  253. 

  254. </div>
    255. 

  255. </div>
    256. 

  256. <a class="anchor" id="gaab931b0d1acfe2f9c1cb78311edf24fc"></a>
    257. 

  257. <div class="memitem">
    258. 

  258. <div class="memproto">
    259. 

  259.       <table class="memname">
    260. 

  260.         <tr>
    261. 

  261.           <td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
    262. 

  262.           <td>(</td>
    263. 

  263.           <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
    264. 

  264.           <td class="paramname"><em>x</em>, </td>
    265. 

  265.         </tr>
    266. 

  266.         <tr>
    267. 

  267.           <td class="paramkey"></td>
    268. 

  268.           <td></td>
    269. 

  269.           <td class="paramtype">unsigned int&#160;</td>
    270. 

  270.           <td class="paramname"><em>Depth</em>&#160;</td>
    271. 

  271.         </tr>
    272. 

  272.         <tr>
    273. 

  273.           <td></td>
    274. 

  274.           <td>)</td>
    275. 

  275.           <td></td><td></td>
    276. 

  276.         </tr>
    277. 

  277.       </table>
    278. 

  278. </div><div class="memdoc">
    279. 

  279. 

  280. <p>Returns the L norm of v. </p>
    281. 

  281. <p>From GLM_GTX_norm extension. </p>
    282. 

  282. 

  283. </div>
    284. 

  284. </div>
    285. 

  285. </div><!-- contents -->
    286. 

  286. <!-- start footer part -->
    287. 

  287. <hr class="footer"/><address class="footer"><small>
    288. 

  288. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    289. 

  289. <img class="footer" src="doxygen.png" alt="doxygen"/>
    290. 

  290. </a> 1.8.10
    291. 

  291. </small></address>
    292. 

  292. </body>
    293. 

  293. </html>
    294.