Platformer in OpenGL
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

282 lines
14 KiB

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