a00371.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  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.10"/>
  7. <title>0.9.9 API documentation: Matrix 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documentation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">Matrix functions<div class="ingroups"><a class="el" href="a00280.html">Core features</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Provides GLSL matrix functions.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <tr class="memitem:gad7928795124768e058f99dce270f5c8d"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:gad7928795124768e058f99dce270f5c8d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00371.html#gad7928795124768e058f99dce270f5c8d">determinant</a> (mat&lt; C, R, T, Q &gt; const &amp;m)</td></tr>
  89. <tr class="memdesc:gad7928795124768e058f99dce270f5c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the determinant of a squared matrix. <a href="a00371.html#gad7928795124768e058f99dce270f5c8d">More...</a><br /></td></tr>
  90. <tr class="separator:gad7928795124768e058f99dce270f5c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gaed509fe8129b01e4f20a6d0de5690091"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier Q&gt; </td></tr>
  92. <tr class="memitem:gaed509fe8129b01e4f20a6d0de5690091"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; C, R, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00371.html#gaed509fe8129b01e4f20a6d0de5690091">inverse</a> (mat&lt; C, R, T, Q &gt; const &amp;m)</td></tr>
  93. <tr class="memdesc:gaed509fe8129b01e4f20a6d0de5690091"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the inverse of a squared matrix. <a href="a00371.html#gaed509fe8129b01e4f20a6d0de5690091">More...</a><br /></td></tr>
  94. <tr class="separator:gaed509fe8129b01e4f20a6d0de5690091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:gaf14569404c779fedca98d0b9b8e58c1f"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier Q&gt; </td></tr>
  96. <tr class="memitem:gaf14569404c779fedca98d0b9b8e58c1f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; C, R, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00371.html#gaf14569404c779fedca98d0b9b8e58c1f">matrixCompMult</a> (mat&lt; C, R, T, Q &gt; const &amp;x, mat&lt; C, R, T, Q &gt; const &amp;y)</td></tr>
  97. <tr class="memdesc:gaf14569404c779fedca98d0b9b8e58c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">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]. <a href="a00371.html#gaf14569404c779fedca98d0b9b8e58c1f">More...</a><br /></td></tr>
  98. <tr class="separator:gaf14569404c779fedca98d0b9b8e58c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:gac29fb7bae75a8e4c1b74cbbf85520e50"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier Q&gt; </td></tr>
  100. <tr class="memitem:gac29fb7bae75a8e4c1b74cbbf85520e50"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL detail::outerProduct_trait&lt; C, R, T, Q &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00371.html#gac29fb7bae75a8e4c1b74cbbf85520e50">outerProduct</a> (vec&lt; C, T, Q &gt; const &amp;c, vec&lt; R, T, Q &gt; const &amp;r)</td></tr>
  101. <tr class="memdesc:gac29fb7bae75a8e4c1b74cbbf85520e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <a href="a00371.html#gac29fb7bae75a8e4c1b74cbbf85520e50">More...</a><br /></td></tr>
  102. <tr class="separator:gac29fb7bae75a8e4c1b74cbbf85520e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:gae679d841da8ce9dbcc6c2d454f15bc35"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier Q&gt; </td></tr>
  104. <tr class="memitem:gae679d841da8ce9dbcc6c2d454f15bc35"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; C, R, T, Q &gt;::transpose_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00371.html#gae679d841da8ce9dbcc6c2d454f15bc35">transpose</a> (mat&lt; C, R, T, Q &gt; const &amp;x)</td></tr>
  105. <tr class="memdesc:gae679d841da8ce9dbcc6c2d454f15bc35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the transposed matrix of x. <a href="a00371.html#gae679d841da8ce9dbcc6c2d454f15bc35">More...</a><br /></td></tr>
  106. <tr class="separator:gae679d841da8ce9dbcc6c2d454f15bc35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <p>Provides GLSL matrix functions. </p>
  110. <p>Include &lt;<a class="el" href="a00057.html" title="Core features ">glm/matrix.hpp</a>&gt; to use these core features. </p>
  111. <h2 class="groupheader">Function Documentation</h2>
  112. <a class="anchor" id="gad7928795124768e058f99dce270f5c8d"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">GLM_FUNC_DECL T glm::determinant </td>
  118. <td>(</td>
  119. <td class="paramtype">mat&lt; C, R, T, Q &gt; const &amp;&#160;</td>
  120. <td class="paramname"><em>m</em></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Return the determinant of a squared matrix. </p>
  126. <dl class="tparams"><dt>Template Parameters</dt><dd>
  127. <table class="tparams">
  128. <tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
  129. <tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
  130. <tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
  131. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  132. </table>
  133. </dd>
  134. </dl>
  135. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
  136. <dd>
  137. <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>
  138. </div>
  139. </div>
  140. <a class="anchor" id="gaed509fe8129b01e4f20a6d0de5690091"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">GLM_FUNC_DECL mat&lt;C, R, T, Q&gt; glm::inverse </td>
  146. <td>(</td>
  147. <td class="paramtype">mat&lt; C, R, T, Q &gt; const &amp;&#160;</td>
  148. <td class="paramname"><em>m</em></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Return the inverse of a squared matrix. </p>
  154. <dl class="tparams"><dt>Template Parameters</dt><dd>
  155. <table class="tparams">
  156. <tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
  157. <tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
  158. <tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
  159. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  160. </table>
  161. </dd>
  162. </dl>
  163. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
  164. <dd>
  165. <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>
  166. </div>
  167. </div>
  168. <a class="anchor" id="gaf14569404c779fedca98d0b9b8e58c1f"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">GLM_FUNC_DECL mat&lt;C, R, T, Q&gt; glm::matrixCompMult </td>
  174. <td>(</td>
  175. <td class="paramtype">mat&lt; C, R, T, Q &gt; const &amp;&#160;</td>
  176. <td class="paramname"><em>x</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">mat&lt; C, R, T, Q &gt; const &amp;&#160;</td>
  182. <td class="paramname"><em>y</em>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <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>
  192. <dl class="tparams"><dt>Template Parameters</dt><dd>
  193. <table class="tparams">
  194. <tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
  195. <tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
  196. <tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
  197. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  198. </table>
  199. </dd>
  200. </dl>
  201. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
  202. <dd>
  203. <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>
  204. </div>
  205. </div>
  206. <a class="anchor" id="gac29fb7bae75a8e4c1b74cbbf85520e50"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">GLM_FUNC_DECL detail::outerProduct_trait&lt;C, R, T, Q&gt;::type glm::outerProduct </td>
  212. <td>(</td>
  213. <td class="paramtype">vec&lt; C, T, Q &gt; const &amp;&#160;</td>
  214. <td class="paramname"><em>c</em>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype">vec&lt; R, T, Q &gt; const &amp;&#160;</td>
  220. <td class="paramname"><em>r</em>&#160;</td>
  221. </tr>
  222. <tr>
  223. <td></td>
  224. <td>)</td>
  225. <td></td><td></td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <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>
  230. <dl class="tparams"><dt>Template Parameters</dt><dd>
  231. <table class="tparams">
  232. <tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
  233. <tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
  234. <tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
  235. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  236. </table>
  237. </dd>
  238. </dl>
  239. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
  240. <dd>
  241. <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>
  242. </div>
  243. </div>
  244. <a class="anchor" id="gae679d841da8ce9dbcc6c2d454f15bc35"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">GLM_FUNC_DECL mat&lt;C, R, T, Q&gt;::transpose_type glm::transpose </td>
  250. <td>(</td>
  251. <td class="paramtype">mat&lt; C, R, T, Q &gt; const &amp;&#160;</td>
  252. <td class="paramname"><em>x</em></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Returns the transposed matrix of x. </p>
  258. <dl class="tparams"><dt>Template Parameters</dt><dd>
  259. <table class="tparams">
  260. <tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
  261. <tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
  262. <tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
  263. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  264. </table>
  265. </dd>
  266. </dl>
  267. <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
  268. <dd>
  269. <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>
  270. </div>
  271. </div>
  272. </div><!-- contents -->
  273. <!-- start footer part -->
  274. <hr class="footer"/><address class="footer"><small>
  275. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  276. <img class="footer" src="doxygen.png" alt="doxygen"/>
  277. </a> 1.8.10
  278. </small></address>
  279. </body>
  280. </html>