Updated API doc

This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 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.9 API documenation: matrix_major_storage.hpp Source File</title>
<title>0.9.9 API documenation: normal.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>
@@ -84,7 +84,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_major_storage.hpp</div> </div>
<div class="title">normal.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00071.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>
@@ -94,86 +94,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_matrix_major_storage is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_normal is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.&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="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_major_storage extension included&quot;)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_normal extension included&quot;)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; GLM_FUNC_DECL mat&lt;2, 2, T, P&gt; <a class="code" href="a00211.html#ga7afc830131aad34244300be5df6f6e0c">rowMajor2</a>(</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v2);</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, qualifier P&gt;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; GLM_FUNC_DECL mat&lt;2, 2, T, P&gt; <a class="code" href="a00211.html#ga7afc830131aad34244300be5df6f6e0c">rowMajor2</a>(</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; mat&lt;2, 2, T, P&gt; <span class="keyword">const</span>&amp; m);</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, qualifier P&gt;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; GLM_FUNC_DECL mat&lt;3, 3, T, P&gt; <a class="code" href="a00211.html#ga458a0aa2af3b7e2be6aa2d28bcfd0223">rowMajor3</a>(</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v3);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; GLM_FUNC_DECL mat&lt;3, 3, T, P&gt; <a class="code" href="a00211.html#ga458a0aa2af3b7e2be6aa2d28bcfd0223">rowMajor3</a>(</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; mat&lt;3, 3, T, P&gt; <span class="keyword">const</span>&amp; m);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, P&gt; <a class="code" href="a00211.html#ga51586db352ba7f8a0840c64cd0b08c3f">rowMajor4</a>(</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v2,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v4);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, P&gt; <a class="code" href="a00211.html#ga51586db352ba7f8a0840c64cd0b08c3f">rowMajor4</a>(</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; mat&lt;4, 4, T, P&gt; <span class="keyword">const</span>&amp; m);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; GLM_FUNC_DECL mat&lt;2, 2, T, P&gt; <a class="code" href="a00211.html#ga6fc5c8a0d9aeb748ce50d57bbab09a41">colMajor2</a>(</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v2);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; GLM_FUNC_DECL mat&lt;2, 2, T, P&gt; <a class="code" href="a00211.html#ga6fc5c8a0d9aeb748ce50d57bbab09a41">colMajor2</a>(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; mat&lt;2, 2, T, P&gt; <span class="keyword">const</span>&amp; m);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; GLM_FUNC_DECL mat&lt;3, 3, T, P&gt; <a class="code" href="a00211.html#gac6ec46a4d21833eb7c321a531ef79c80">colMajor3</a>(</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v3);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; GLM_FUNC_DECL mat&lt;3, 3, T, P&gt; <a class="code" href="a00211.html#gac6ec46a4d21833eb7c321a531ef79c80">colMajor3</a>(</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; mat&lt;3, 3, T, P&gt; <span class="keyword">const</span>&amp; m);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, P&gt; <a class="code" href="a00211.html#ga62fb78aa6191e93716d99da69d6a5b15">colMajor4</a>(</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v4);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, P&gt; <a class="code" href="a00211.html#ga62fb78aa6191e93716d99da69d6a5b15">colMajor4</a>(</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; mat&lt;4, 4, T, P&gt; <span class="keyword">const</span>&amp; m);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="preprocessor">#include &quot;matrix_major_storage.inl&quot;</span></div>
<div class="ttc" id="a00211_html_ga62fb78aa6191e93716d99da69d6a5b15"><div class="ttname"><a href="a00211.html#ga62fb78aa6191e93716d99da69d6a5b15">glm::colMajor4</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 4, T, P &gt; colMajor4(mat&lt; 4, 4, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></div>
<div class="ttc" id="a00211_html_ga6fc5c8a0d9aeb748ce50d57bbab09a41"><div class="ttname"><a href="a00211.html#ga6fc5c8a0d9aeb748ce50d57bbab09a41">glm::colMajor2</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 2, 2, T, P &gt; colMajor2(mat&lt; 2, 2, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></div>
<div class="ttc" id="a00211_html_ga7afc830131aad34244300be5df6f6e0c"><div class="ttname"><a href="a00211.html#ga7afc830131aad34244300be5df6f6e0c">glm::rowMajor2</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 2, 2, T, P &gt; rowMajor2(mat&lt; 2, 2, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.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="a00211_html_ga51586db352ba7f8a0840c64cd0b08c3f"><div class="ttname"><a href="a00211.html#ga51586db352ba7f8a0840c64cd0b08c3f">glm::rowMajor4</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 4, T, P &gt; rowMajor4(mat&lt; 4, 4, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="ttc" id="a00211_html_ga458a0aa2af3b7e2be6aa2d28bcfd0223"><div class="ttname"><a href="a00211.html#ga458a0aa2af3b7e2be6aa2d28bcfd0223">glm::rowMajor3</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 3, 3, T, P &gt; rowMajor3(mat&lt; 3, 3, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a row major matrix from other matrix. </div></div>
<div class="ttc" id="a00211_html_gac6ec46a4d21833eb7c321a531ef79c80"><div class="ttname"><a href="a00211.html#gac6ec46a4d21833eb7c321a531ef79c80">glm::colMajor3</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 3, 3, T, P &gt; colMajor3(mat&lt; 3, 3, T, P &gt; const &amp;m)</div><div class="ttdoc">Build a column major matrix from other matrix. </div></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, qualifier Q&gt; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00204.html#gaff1cb5496925dfa7962df457772a7f35">triangleNormal</a>(vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; p1, vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; p2, vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; p3);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &quot;normal.inl&quot;</span></div>
<div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
<div class="ttc" id="a00204_html_gaff1cb5496925dfa7962df457772a7f35"><div class="ttname"><a href="a00204.html#gaff1cb5496925dfa7962df457772a7f35">glm::triangleNormal</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; triangleNormal(vec&lt; 3, T, Q &gt; const &amp;p1, vec&lt; 3, T, Q &gt; const &amp;p2, vec&lt; 3, T, Q &gt; const &amp;p3)</div><div class="ttdoc">Computes triangle normal from triangle points. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>