Updated API documentation

This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 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.7: matrix_access.hpp Source File</title>
<title>0.9.8: matrix_operation.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.7
<div id="projectname">0.9.8
</div>
</td>
</tr>
@@ -41,55 +41,76 @@
</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_9440d7c11b99dcd7e5d369c7cf9802fe.html">gtc</a></li> </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>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_access.hpp</div> </div>
<div class="title">matrix_operation.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00068.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="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_matrix_access extension included&quot;)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</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> genType&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL <span class="keyword">typename</span> genType::row_type <a class="code" href="a00171.html#gaadcc64829aadf4103477679e48c7594f">row</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; genType <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; length_t index);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00171.html#gaadcc64829aadf4103477679e48c7594f">row</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; genType <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; length_t index,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">typename</span> genType::row_type <span class="keyword">const</span> &amp; x);</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> genType&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; GLM_FUNC_DECL <span class="keyword">typename</span> genType::col_type <a class="code" href="a00171.html#ga9e757377523890e8b80c5843dbe4dd15">column</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; genType <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; length_t index);</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> genType&gt;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00171.html#ga9e757377523890e8b80c5843dbe4dd15">column</a>(</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; genType <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; length_t index,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">typename</span> genType::col_type <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#include &quot;matrix_access.inl&quot;</span></div>
<div class="ttc" id="a00171_html_ga9e757377523890e8b80c5843dbe4dd15"><div class="ttname"><a href="a00171.html#ga9e757377523890e8b80c5843dbe4dd15">glm::column</a></div><div class="ttdeci">GLM_FUNC_DECL genType column(genType const &amp;m, length_t index, typename genType::col_type const &amp;x)</div><div class="ttdoc">Set a specific column to a matrix. </div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00040">_noise.hpp:40</a></div></div>
<div class="ttc" id="a00171_html_gaadcc64829aadf4103477679e48c7594f"><div class="ttname"><a href="a00171.html#gaadcc64829aadf4103477679e48c7594f">glm::row</a></div><div class="ttdeci">GLM_FUNC_DECL genType row(genType const &amp;m, length_t index, typename genType::row_type const &amp;x)</div><div class="ttdoc">Set a specific row to a matrix. </div></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_operation extension included&quot;)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</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; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; GLM_FUNC_DECL tmat2x2&lt;T, P&gt; <a class="code" href="a00207.html#ga01dc503262dba9c457113d131fc8c024">diagonal2x2</a>(</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</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> T, precision P&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; GLM_FUNC_DECL tmat2x3&lt;T, P&gt; <a class="code" href="a00207.html#ga763817f07d6a94b722a48adfa87a35db">diagonal2x3</a>(</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; GLM_FUNC_DECL tmat2x4&lt;T, P&gt; <a class="code" href="a00207.html#ga49b37c819cf6dd8e35112ed1a13d45a3">diagonal2x4</a>(</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; GLM_FUNC_DECL tmat3x2&lt;T, P&gt; <a class="code" href="a00207.html#ga586e1ced91fd8a7c414186a200f13532">diagonal3x2</a>(</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; GLM_FUNC_DECL tmat3x3&lt;T, P&gt; <a class="code" href="a00207.html#ga8e817dba22f2305cdebae07bbbe0360c">diagonal3x3</a>(</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; GLM_FUNC_DECL tmat3x4&lt;T, P&gt; <a class="code" href="a00207.html#gae3f85af86c18c80f2acbe3223feb8e81">diagonal3x4</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; GLM_FUNC_DECL tmat4x2&lt;T, P&gt; <a class="code" href="a00207.html#ga70cc5632aa9f41e7cf0b81fee6f2bfe6">diagonal4x2</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; GLM_FUNC_DECL tmat4x3&lt;T, P&gt; <a class="code" href="a00207.html#ga4242ea5681f81539e0c5b54fadcd9ddf">diagonal4x3</a>(</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00207.html#gade576e044d8e52f343166f665589d782">diagonal4x4</a>(</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#include &quot;matrix_operation.inl&quot;</span></div>
<div class="ttc" id="a00207_html_gade576e044d8e52f343166f665589d782"><div class="ttname"><a href="a00207.html#gade576e044d8e52f343166f665589d782">glm::diagonal4x4</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; diagonal4x4(tvec4&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal 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="a00207_html_ga49b37c819cf6dd8e35112ed1a13d45a3"><div class="ttname"><a href="a00207.html#ga49b37c819cf6dd8e35112ed1a13d45a3">glm::diagonal2x4</a></div><div class="ttdeci">GLM_FUNC_DECL tmat2x4&lt; T, P &gt; diagonal2x4(tvec2&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga8e817dba22f2305cdebae07bbbe0360c"><div class="ttname"><a href="a00207.html#ga8e817dba22f2305cdebae07bbbe0360c">glm::diagonal3x3</a></div><div class="ttdeci">GLM_FUNC_DECL tmat3x3&lt; T, P &gt; diagonal3x3(tvec3&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga70cc5632aa9f41e7cf0b81fee6f2bfe6"><div class="ttname"><a href="a00207.html#ga70cc5632aa9f41e7cf0b81fee6f2bfe6">glm::diagonal4x2</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x2&lt; T, P &gt; diagonal4x2(tvec2&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga763817f07d6a94b722a48adfa87a35db"><div class="ttname"><a href="a00207.html#ga763817f07d6a94b722a48adfa87a35db">glm::diagonal2x3</a></div><div class="ttdeci">GLM_FUNC_DECL tmat2x3&lt; T, P &gt; diagonal2x3(tvec2&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga01dc503262dba9c457113d131fc8c024"><div class="ttname"><a href="a00207.html#ga01dc503262dba9c457113d131fc8c024">glm::diagonal2x2</a></div><div class="ttdeci">GLM_FUNC_DECL tmat2x2&lt; T, P &gt; diagonal2x2(tvec2&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga586e1ced91fd8a7c414186a200f13532"><div class="ttname"><a href="a00207.html#ga586e1ced91fd8a7c414186a200f13532">glm::diagonal3x2</a></div><div class="ttdeci">GLM_FUNC_DECL tmat3x2&lt; T, P &gt; diagonal3x2(tvec2&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_gae3f85af86c18c80f2acbe3223feb8e81"><div class="ttname"><a href="a00207.html#gae3f85af86c18c80f2acbe3223feb8e81">glm::diagonal3x4</a></div><div class="ttdeci">GLM_FUNC_DECL tmat3x4&lt; T, P &gt; diagonal3x4(tvec3&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00207_html_ga4242ea5681f81539e0c5b54fadcd9ddf"><div class="ttname"><a href="a00207.html#ga4242ea5681f81539e0c5b54fadcd9ddf">glm::diagonal4x3</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x3&lt; T, P &gt; diagonal4x3(tvec3&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>