a00131.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  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. <title>Matrix functions</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="top"><!-- do not remove this div! -->
  11. <div id="titlearea">
  12. <table cellspacing="0" cellpadding="0">
  13. <tbody>
  14. <tr style="height: 56px;">
  15. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  16. </tr>
  17. </tbody>
  18. </table>
  19. </div>
  20. <!-- Generated by Doxygen 1.7.5.1 -->
  21. <div id="navrow1" class="tabs">
  22. <ul class="tablist">
  23. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  24. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  25. <li><a href="modules.html"><span>Modules</span></a></li>
  26. <li><a href="annotated.html"><span>Classes</span></a></li>
  27. <li><a href="files.html"><span>Files</span></a></li>
  28. </ul>
  29. </div>
  30. </div>
  31. <div class="header">
  32. <div class="summary">
  33. <a href="#func-members">Functions</a> </div>
  34. <div class="headertitle">
  35. <div class="title">Matrix functions</div> </div>
  36. <div class="ingroups"><a class="el" href="a00139.html">GLM Core</a></div></div>
  37. <div class="contents">
  38. <table class="memberdecls">
  39. <tr><td colspan="2"><h2><a name="func-members"></a>
  40. Functions</h2></td></tr>
  41. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  42. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat2x2&lt; valType &gt;<br class="typebreak"/>
  43. ::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#gad3bfb2098e1572d2131a261c1fb76dd4">determinant</a> (detail::tmat2x2&lt; valType &gt; const &amp;m)</td></tr>
  44. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  45. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; valType &gt;<br class="typebreak"/>
  46. ::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#ga2f26bb474e077cf03b9db23f813e8450">determinant</a> (detail::tmat3x3&lt; valType &gt; const &amp;m)</td></tr>
  47. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  48. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;<br class="typebreak"/>
  49. ::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#ga1daa306eecf6e8b379626d761b8c222f">determinant</a> (detail::tmat4x4&lt; valType &gt; const &amp;m)</td></tr>
  50. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  51. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat2x2&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#gada3384a86cf38a1fd96275194b8ba8c0">inverse</a> (detail::tmat2x2&lt; valType &gt; const &amp;m)</td></tr>
  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  53. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#ga1a455651f7ba323ade0cd9191542b179">inverse</a> (detail::tmat3x3&lt; valType &gt; const &amp;m)</td></tr>
  54. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  55. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#gabc94b29dea14e111e48bc963c47559b2">inverse</a> (detail::tmat4x4&lt; valType &gt; const &amp;m)</td></tr>
  56. <tr><td class="memTemplParams" colspan="2">template&lt;typename matType &gt; </td></tr>
  57. <tr><td class="memTemplItemLeft" align="right" valign="top">matType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#ga0e48491a51b3f366d671c01894705605">matrixCompMult</a> (matType const &amp;x, matType const &amp;y)</td></tr>
  58. <tr><td class="memTemplParams" colspan="2">template&lt;typename vecType , typename matType &gt; </td></tr>
  59. <tr><td class="memTemplItemLeft" align="right" valign="top">matType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#ga5d896e8651512fc098a677dbe403eeac">outerProduct</a> (vecType const &amp;c, vecType const &amp;r)</td></tr>
  60. <tr><td class="memTemplParams" colspan="2">template&lt;typename matType &gt; </td></tr>
  61. <tr><td class="memTemplItemLeft" align="right" valign="top">matType::transpose_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00131.html#gac58a4106a57fb7da41b3aeae3832998b">transpose</a> (matType const &amp;x)</td></tr>
  62. </table>
  63. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  64. <p>For each of the following built-in matrix functions, there is both a single-precision floating point version, where all arguments and return values are single precision, and a double-precision floating version, where all arguments and return values are double precision. </p>
  65. <p>Only the single-precision floating point version is shown. </p>
  66. <hr/><h2>Function Documentation</h2>
  67. <a class="anchor" id="gad3bfb2098e1572d2131a261c1fb76dd4"></a><!-- doxytag: member="glm::determinant" ref="gad3bfb2098e1572d2131a261c1fb76dd4" args="(detail::tmat2x2&lt; valType &gt; const &amp;m)" -->
  68. <div class="memitem">
  69. <div class="memproto">
  70. <table class="memname">
  71. <tr>
  72. <td class="memname">detail::tmat2x2&lt;valType&gt;::value_type glm::determinant </td>
  73. <td>(</td>
  74. <td class="paramtype">detail::tmat2x2&lt; valType &gt; const &amp;&#160;</td>
  75. <td class="paramname"><em>m</em></td><td>)</td>
  76. <td></td>
  77. </tr>
  78. </table>
  79. </div>
  80. <div class="memdoc">
  81. <p>Return the determinant of a mat2 matrix. </p>
  82. <dl><dt><b>Template Parameters:</b></dt><dd>
  83. <table class="">
  84. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  85. </table>
  86. </dd>
  87. </dl>
  88. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
  89. <dd>
  90. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  91. </div>
  92. </div>
  93. <a class="anchor" id="ga2f26bb474e077cf03b9db23f813e8450"></a><!-- doxytag: member="glm::determinant" ref="ga2f26bb474e077cf03b9db23f813e8450" args="(detail::tmat3x3&lt; valType &gt; const &amp;m)" -->
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname">detail::tmat3x3&lt;valType&gt;::value_type glm::determinant </td>
  99. <td>(</td>
  100. <td class="paramtype">detail::tmat3x3&lt; valType &gt; const &amp;&#160;</td>
  101. <td class="paramname"><em>m</em></td><td>)</td>
  102. <td></td>
  103. </tr>
  104. </table>
  105. </div>
  106. <div class="memdoc">
  107. <p>Return the determinant of a mat3 matrix. </p>
  108. <dl><dt><b>Template Parameters:</b></dt><dd>
  109. <table class="">
  110. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  111. </table>
  112. </dd>
  113. </dl>
  114. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
  115. <dd>
  116. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  117. </div>
  118. </div>
  119. <a class="anchor" id="ga1daa306eecf6e8b379626d761b8c222f"></a><!-- doxytag: member="glm::determinant" ref="ga1daa306eecf6e8b379626d761b8c222f" args="(detail::tmat4x4&lt; valType &gt; const &amp;m)" -->
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">detail::tmat4x4&lt;valType&gt;::value_type glm::determinant </td>
  125. <td>(</td>
  126. <td class="paramtype">detail::tmat4x4&lt; valType &gt; const &amp;&#160;</td>
  127. <td class="paramname"><em>m</em></td><td>)</td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <div class="memdoc">
  133. <p>Return the determinant of a mat4 matrix. </p>
  134. <dl><dt><b>Template Parameters:</b></dt><dd>
  135. <table class="">
  136. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  137. </table>
  138. </dd>
  139. </dl>
  140. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
  141. <dd>
  142. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  143. </div>
  144. </div>
  145. <a class="anchor" id="gada3384a86cf38a1fd96275194b8ba8c0"></a><!-- doxytag: member="glm::inverse" ref="gada3384a86cf38a1fd96275194b8ba8c0" args="(detail::tmat2x2&lt; valType &gt; const &amp;m)" -->
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">detail::tmat2x2&lt;valType&gt; glm::inverse </td>
  151. <td>(</td>
  152. <td class="paramtype">detail::tmat2x2&lt; valType &gt; const &amp;&#160;</td>
  153. <td class="paramname"><em>m</em></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </div>
  158. <div class="memdoc">
  159. <p>Return the inverse of a mat2 matrix. </p>
  160. <dl><dt><b>Template Parameters:</b></dt><dd>
  161. <table class="">
  162. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
  167. <dd>
  168. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  169. </div>
  170. </div>
  171. <a class="anchor" id="ga1a455651f7ba323ade0cd9191542b179"></a><!-- doxytag: member="glm::inverse" ref="ga1a455651f7ba323ade0cd9191542b179" args="(detail::tmat3x3&lt; valType &gt; const &amp;m)" -->
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">detail::tmat3x3&lt;valType&gt; glm::inverse </td>
  177. <td>(</td>
  178. <td class="paramtype">detail::tmat3x3&lt; valType &gt; const &amp;&#160;</td>
  179. <td class="paramname"><em>m</em></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </div>
  184. <div class="memdoc">
  185. <p>Return the inverse of a mat3 matrix. </p>
  186. <dl><dt><b>Template Parameters:</b></dt><dd>
  187. <table class="">
  188. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  189. </table>
  190. </dd>
  191. </dl>
  192. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
  193. <dd>
  194. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="gabc94b29dea14e111e48bc963c47559b2"></a><!-- doxytag: member="glm::inverse" ref="gabc94b29dea14e111e48bc963c47559b2" args="(detail::tmat4x4&lt; valType &gt; const &amp;m)" -->
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">detail::tmat4x4&lt;valType&gt; glm::inverse </td>
  203. <td>(</td>
  204. <td class="paramtype">detail::tmat4x4&lt; valType &gt; const &amp;&#160;</td>
  205. <td class="paramname"><em>m</em></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </div>
  210. <div class="memdoc">
  211. <p>Return the inverse of a mat4 matrix. </p>
  212. <dl><dt><b>Template Parameters:</b></dt><dd>
  213. <table class="">
  214. <tr><td class="paramname">valType</td><td>Floating-point scalar types. </td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
  219. <dd>
  220. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  221. </div>
  222. </div>
  223. <a class="anchor" id="ga0e48491a51b3f366d671c01894705605"></a><!-- doxytag: member="glm::matrixCompMult" ref="ga0e48491a51b3f366d671c01894705605" args="(matType const &amp;x, matType const &amp;y)" -->
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">matType glm::matrixCompMult </td>
  229. <td>(</td>
  230. <td class="paramtype">matType const &amp;&#160;</td>
  231. <td class="paramname"><em>x</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">matType const &amp;&#160;</td>
  237. <td class="paramname"><em>y</em>&#160;</td>
  238. </tr>
  239. <tr>
  240. <td></td>
  241. <td>)</td>
  242. <td></td><td></td>
  243. </tr>
  244. </table>
  245. </div>
  246. <div class="memdoc">
  247. <p>Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and y[i][j]. </p>
  248. <dl><dt><b>Template Parameters:</b></dt><dd>
  249. <table class="">
  250. <tr><td class="paramname">matType</td><td>Floating-point matrix types. </td></tr>
  251. </table>
  252. </dd>
  253. </dl>
  254. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
  255. <dd>
  256. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  257. </div>
  258. </div>
  259. <a class="anchor" id="ga5d896e8651512fc098a677dbe403eeac"></a><!-- doxytag: member="glm::outerProduct" ref="ga5d896e8651512fc098a677dbe403eeac" args="(vecType const &amp;c, vecType const &amp;r)" -->
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">matType glm::outerProduct </td>
  265. <td>(</td>
  266. <td class="paramtype">vecType const &amp;&#160;</td>
  267. <td class="paramname"><em>c</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">vecType const &amp;&#160;</td>
  273. <td class="paramname"><em>r</em>&#160;</td>
  274. </tr>
  275. <tr>
  276. <td></td>
  277. <td>)</td>
  278. <td></td><td></td>
  279. </tr>
  280. </table>
  281. </div>
  282. <div class="memdoc">
  283. <p>Treats the first parameter c as a column vector and the second parameter r as a row vector and does a linear algebraic matrix multiply c * r. </p>
  284. <dl><dt><b>Template Parameters:</b></dt><dd>
  285. <table class="">
  286. <tr><td class="paramname">matType</td><td>Floating-point matrix types. </td></tr>
  287. </table>
  288. </dd>
  289. </dl>
  290. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
  291. <dd>
  292. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  293. <dl class="todo"><dt><b><a class="el" href="a00215.html#_todo000006">Todo:</a></b></dt><dd>Clarify the declaration to specify that matType doesn't have to be provided when used.</dd></dl>
  294. </div>
  295. </div>
  296. <a class="anchor" id="gac58a4106a57fb7da41b3aeae3832998b"></a><!-- doxytag: member="glm::transpose" ref="gac58a4106a57fb7da41b3aeae3832998b" args="(matType const &amp;x)" -->
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">matType::transpose_type glm::transpose </td>
  302. <td>(</td>
  303. <td class="paramtype">matType const &amp;&#160;</td>
  304. <td class="paramname"><em>x</em></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div>
  309. <div class="memdoc">
  310. <p>Returns the transposed matrix of x. </p>
  311. <dl><dt><b>Template Parameters:</b></dt><dd>
  312. <table class="">
  313. <tr><td class="paramname">matType</td><td>Floating-point matrix types. </td></tr>
  314. </table>
  315. </dd>
  316. </dl>
  317. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
  318. <dd>
  319. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
  320. </div>
  321. </div>
  322. </div>
  323. <hr class="footer"/><address class="footer"><small>
  324. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  325. <img class="footer" src="doxygen.png" alt="doxygen"/>
  326. </a> 1.7.5.1
  327. </small></address>
  328. </body>
  329. </html>