Updated doxygen API doc

This commit is contained in:
Christophe Riccio
2016-11-13 00:39:32 +01:00
parent 83d14ee411
commit d8ca117cb6
394 changed files with 48595 additions and 40958 deletions

View File

@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>0.9.8: matrix_major_storage.hpp Source File</title>
<title>0.9.8 API documenation: matrix_inverse.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.8
<div id="projectname">0.9.8 API documenation
</div>
</td>
</tr>
@@ -41,97 +41,43 @@
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_8d176b5b7dd0ae42ea6876078f2bde49.html">gtx</a></li> </ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_7997edb062bdde9a99cb6835d42b0d9d.html">gtc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_major_storage.hpp</div> </div>
<div class="title">matrix_inverse.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00067.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_major_storage extension included&quot;)</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; GLM_FUNC_DECL tmat2x2&lt;T, P&gt; <a class="code" href="a00206.html#ga42a006aa66198452bd3c89415f892196">rowMajor2</a>(</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v2);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; GLM_FUNC_DECL tmat2x2&lt;T, P&gt; <a class="code" href="a00206.html#ga42a006aa66198452bd3c89415f892196">rowMajor2</a>(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; GLM_FUNC_DECL tmat3x3&lt;T, P&gt; <a class="code" href="a00206.html#ga38537061135b55e7a053926ca55e6e20">rowMajor3</a>(</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v3);</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../matrix.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../mat2x2.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;../mat3x3.hpp&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../mat4x4.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_matrix_inverse extension included&quot;)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00140.html">glm</a></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00168.html#gae0fcc5fc8783291f9702272de428fa0e">affineInverse</a>(genType <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00168.html#gab213cd0e3ead5f316d583f99d6312008">inverseTranspose</a>(genType <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; GLM_FUNC_DECL tmat3x3&lt;T, P&gt; <a class="code" href="a00206.html#ga38537061135b55e7a053926ca55e6e20">rowMajor3</a>(</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00206.html#ga85771a88c114a088a0414bcfce55e729">rowMajor4</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v2,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v4);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00206.html#ga85771a88c114a088a0414bcfce55e729">rowMajor4</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; GLM_FUNC_DECL tmat2x2&lt;T, P&gt; <a class="code" href="a00206.html#ga5cfd25de9d5b4c6a825085f38ddfeff7">colMajor2</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v2);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; GLM_FUNC_DECL tmat2x2&lt;T, P&gt; <a class="code" href="a00206.html#ga5cfd25de9d5b4c6a825085f38ddfeff7">colMajor2</a>(</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; GLM_FUNC_DECL tmat3x3&lt;T, P&gt; <a class="code" href="a00206.html#gaa93f3dcc47ced18e5db4a853363d9386">colMajor3</a>(</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v3);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; GLM_FUNC_DECL tmat3x3&lt;T, P&gt; <a class="code" href="a00206.html#gaa93f3dcc47ced18e5db4a853363d9386">colMajor3</a>(</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00206.html#ga7592acfd27da055e2d7c39564cf8803d">colMajor4</a>(</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v4);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00206.html#ga7592acfd27da055e2d7c39564cf8803d">colMajor4</a>(</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="preprocessor">#include &quot;matrix_major_storage.inl&quot;</span></div>
<div class="ttc" id="a00206_html_ga7592acfd27da055e2d7c39564cf8803d"><div class="ttname"><a href="a00206.html#ga7592acfd27da055e2d7c39564cf8803d">glm::colMajor4</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; colMajor4(tmat4x4&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></div>
<div class="ttc" id="a00206_html_ga42a006aa66198452bd3c89415f892196"><div class="ttname"><a href="a00206.html#ga42a006aa66198452bd3c89415f892196">glm::rowMajor2</a></div><div class="ttdeci">GLM_FUNC_DECL tmat2x2&lt; T, P &gt; rowMajor2(tmat2x2&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="ttc" id="a00206_html_ga38537061135b55e7a053926ca55e6e20"><div class="ttname"><a href="a00206.html#ga38537061135b55e7a053926ca55e6e20">glm::rowMajor3</a></div><div class="ttdeci">GLM_FUNC_DECL tmat3x3&lt; T, P &gt; rowMajor3(tmat3x3&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="ttc" id="a00206_html_ga5cfd25de9d5b4c6a825085f38ddfeff7"><div class="ttname"><a href="a00206.html#ga5cfd25de9d5b4c6a825085f38ddfeff7">glm::colMajor2</a></div><div class="ttdeci">GLM_FUNC_DECL tmat2x2&lt; T, P &gt; colMajor2(tmat2x2&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></div>
<div class="ttc" id="a00141_html"><div class="ttname"><a href="a00141.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
<div class="ttc" id="a00206_html_gaa93f3dcc47ced18e5db4a853363d9386"><div class="ttname"><a href="a00206.html#gaa93f3dcc47ced18e5db4a853363d9386">glm::colMajor3</a></div><div class="ttdeci">GLM_FUNC_DECL tmat3x3&lt; T, P &gt; colMajor3(tmat3x3&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></div>
<div class="ttc" id="a00206_html_ga85771a88c114a088a0414bcfce55e729"><div class="ttname"><a href="a00206.html#ga85771a88c114a088a0414bcfce55e729">glm::rowMajor4</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; rowMajor4(tmat4x4&lt; T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#include &quot;matrix_inverse.inl&quot;</span></div>
<div class="ttc" id="a00140_html"><div class="ttname"><a href="a00140.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
<div class="ttc" id="a00168_html_gab213cd0e3ead5f316d583f99d6312008"><div class="ttname"><a href="a00168.html#gab213cd0e3ead5f316d583f99d6312008">glm::inverseTranspose</a></div><div class="ttdeci">GLM_FUNC_DECL genType inverseTranspose(genType const &amp;m)</div><div class="ttdoc">Compute the inverse transpose of a matrix. </div></div>
<div class="ttc" id="a00168_html_gae0fcc5fc8783291f9702272de428fa0e"><div class="ttname"><a href="a00168.html#gae0fcc5fc8783291f9702272de428fa0e">glm::affineInverse</a></div><div class="ttdeci">GLM_FUNC_DECL genType affineInverse(genType const &amp;m)</div><div class="ttdoc">Fast matrix inverse for affine matrix. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>