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
/
a00150.html

a00150.html 10 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210 
  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: Matrix functions</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">Matrix functions<div class="ingroups"><a class="el" href="a00156.html">GLM Core</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:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
    49. 

  49. <tr class="memitem:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga26ea77c574802bc6fc193c40478718d2">determinant</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
    50. 

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

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

  52. <tr class="memitem:gaa7e1d5586cd499126cec76e0f11871e3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaa7e1d5586cd499126cec76e0f11871e3">inverse</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
    53. 

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

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

  55. <tr class="memitem:ga4a54992e4741188ee624b21e3ba91814"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga4a54992e4741188ee624b21e3ba91814">matrixCompMult</a> (matType&lt; T, P &gt; const &amp;x, matType&lt; T, P &gt; const &amp;y)</td></tr>
    56. 

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

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

  58. <tr class="memitem:gae9f513dc8e4f3ceb993669321b6d0f09"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL detail::outerProduct_trait&lt; T, P, vecTypeA, vecTypeB &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gae9f513dc8e4f3ceb993669321b6d0f09">outerProduct</a> (vecTypeA&lt; T, P &gt; const &amp;c, vecTypeB&lt; T, P &gt; const &amp;r)</td></tr>
    59. 

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

  60. </table>
    61. 

  61. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    62. 

  62. <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>
    63. 

  63. <p>Only the single-precision floating point version is shown. </p>
    64. 

  64. <h2 class="groupheader">Function Documentation</h2>
    65. 

  65. <a class="anchor" id="ga26ea77c574802bc6fc193c40478718d2"></a>
    66. 

  66. <div class="memitem">
    67. 

  67. <div class="memproto">
    68. 

  68.       <table class="memname">
    69. 

  69.         <tr>
    70. 

  70.           <td class="memname">GLM_FUNC_DECL T glm::determinant </td>
    71. 

  71.           <td>(</td>
    72. 

  72.           <td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
    73. 

  73.           <td class="paramname"><em>m</em></td><td>)</td>
    74. 

  74.           <td></td>
    75. 

  75.         </tr>
    76. 

  76.       </table>
    77. 

  77. </div><div class="memdoc">
    78. 

  78. 

  79. <p>Returns the transposed matrix of x. </p>
    80. 

  80. <dl class="tparams"><dt>Template Parameters</dt><dd>
    81. 

  81.   <table class="tparams">
    82. 

  82.     <tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
    83. 

  83.   </table>
    84. 

  84.   </dd>
    85. 

  85. </dl>
    86. 

  86. <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>
    87. 

  87. <dd>
    88. 

  88. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> Return the determinant of a squared matrix.</dd></dl>
    89. 

  89. <dl class="tparams"><dt>Template Parameters</dt><dd>
    90. 

  90.   <table class="tparams">
    91. 

  91.     <tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
    92. 

  92.   </table>
    93. 

  93.   </dd>
    94. 

  94. </dl>
    95. 

  95. <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>
    96. 

  96. <dd>
    97. 

  97. <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>
    98. 

  98. 

  99. </div>
    100. 

  100. </div>
    101. 

  101. <a class="anchor" id="gaa7e1d5586cd499126cec76e0f11871e3"></a>
    102. 

  102. <div class="memitem">
    103. 

  103. <div class="memproto">
    104. 

  104.       <table class="memname">
    105. 

  105.         <tr>
    106. 

  106.           <td class="memname">GLM_FUNC_DECL matType&lt; T, P &gt; inverse </td>
    107. 

  107.           <td>(</td>
    108. 

  108.           <td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
    109. 

  109.           <td class="paramname"><em>m</em></td><td>)</td>
    110. 

  110.           <td></td>
    111. 

  111.         </tr>
    112. 

  112.       </table>
    113. 

  113. </div><div class="memdoc">
    114. 

  114. 

  115. <p>Return the inverse of a squared matrix. </p>
    116. 

  116. <dl class="tparams"><dt>Template Parameters</dt><dd>
    117. 

  117.   <table class="tparams">
    118. 

  118.     <tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
    119. 

  119.   </table>
    120. 

  120.   </dd>
    121. 

  121. </dl>
    122. 

  122. <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>
    123. 

  123. <dd>
    124. 

  124. <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>
    125. 

  125. 

  126. </div>
    127. 

  127. </div>
    128. 

  128. <a class="anchor" id="ga4a54992e4741188ee624b21e3ba91814"></a>
    129. 

  129. <div class="memitem">
    130. 

  130. <div class="memproto">
    131. 

  131.       <table class="memname">
    132. 

  132.         <tr>
    133. 

  133.           <td class="memname">GLM_FUNC_DECL matType&lt;T, P&gt; glm::matrixCompMult </td>
    134. 

  134.           <td>(</td>
    135. 

  135.           <td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
    136. 

  136.           <td class="paramname"><em>x</em>, </td>
    137. 

  137.         </tr>
    138. 

  138.         <tr>
    139. 

  139.           <td class="paramkey"></td>
    140. 

  140.           <td></td>
    141. 

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

  142.           <td class="paramname"><em>y</em>&#160;</td>
    143. 

  143.         </tr>
    144. 

  144.         <tr>
    145. 

  145.           <td></td>
    146. 

  146.           <td>)</td>
    147. 

  147.           <td></td><td></td>
    148. 

  148.         </tr>
    149. 

  149.       </table>
    150. 

  150. </div><div class="memdoc">
    151. 

  151. 

  152. <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>
    153. 

  153. <dl class="tparams"><dt>Template Parameters</dt><dd>
    154. 

  154.   <table class="tparams">
    155. 

  155.     <tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
    156. 

  156.   </table>
    157. 

  157.   </dd>
    158. 

  158. </dl>
    159. 

  159. <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>
    160. 

  160. <dd>
    161. 

  161. <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>
    162. 

  162. 

  163. </div>
    164. 

  164. </div>
    165. 

  165. <a class="anchor" id="gae9f513dc8e4f3ceb993669321b6d0f09"></a>
    166. 

  166. <div class="memitem">
    167. 

  167. <div class="memproto">
    168. 

  168.       <table class="memname">
    169. 

  169.         <tr>
    170. 

  170.           <td class="memname">GLM_FUNC_DECL detail::outerProduct_trait&lt;T, P, vecTypeA, vecTypeB&gt;::type glm::outerProduct </td>
    171. 

  171.           <td>(</td>
    172. 

  172.           <td class="paramtype">vecTypeA&lt; T, P &gt; const &amp;&#160;</td>
    173. 

  173.           <td class="paramname"><em>c</em>, </td>
    174. 

  174.         </tr>
    175. 

  175.         <tr>
    176. 

  176.           <td class="paramkey"></td>
    177. 

  177.           <td></td>
    178. 

  178.           <td class="paramtype">vecTypeB&lt; T, P &gt; const &amp;&#160;</td>
    179. 

  179.           <td class="paramname"><em>r</em>&#160;</td>
    180. 

  180.         </tr>
    181. 

  181.         <tr>
    182. 

  182.           <td></td>
    183. 

  183.           <td>)</td>
    184. 

  184.           <td></td><td></td>
    185. 

  185.         </tr>
    186. 

  186.       </table>
    187. 

  187. </div><div class="memdoc">
    188. 

  188. 

  189. <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>
    190. 

  190. <dl class="tparams"><dt>Template Parameters</dt><dd>
    191. 

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

  192.     <tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
    193. 

  193.   </table>
    194. 

  194.   </dd>
    195. 

  195. </dl>
    196. 

  196. <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>
    197. 

  197. <dd>
    198. 

  198. <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>
    199. 

  199. 

  200. </div>
    201. 

  201. </div>
    202. 

  202. </div><!-- contents -->
    203. 

  203. <!-- start footer part -->
    204. 

  204. <hr class="footer"/><address class="footer"><small>
    205. 

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

  206. <img class="footer" src="doxygen.png" alt="doxygen"/>
    207. 

  207. </a> 1.8.10
    208. 

  208. </small></address>
    209. 

  209. </body>
    210. 

  210. </html>
    211.