mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

95
doc/api/a00072_source.html
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_operation.hpp Source File</title>
<title>0.9.9 API documenation: normalize_dot.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,75 +84,38 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_operation.hpp</div> </div>
<div class="title">normalize_dot.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00072.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="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">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_matrix_operation 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">#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="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_operation extension included&quot;)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</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;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL mat&lt;2, 2, T, P&gt; <a class="code" href="a00212.html#ga2a5a236689e94ef72fcef64064e9bd5a">diagonal2x2</a>(</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; GLM_FUNC_DECL mat&lt;2, 3, T, P&gt; <a class="code" href="a00212.html#gaba34be247fae13984a657f18f985b889">diagonal2x3</a>(</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; GLM_FUNC_DECL mat&lt;2, 4, T, P&gt; <a class="code" href="a00212.html#ga420b4c9e124eca9e4730e4d9f2ca04a6">diagonal2x4</a>(</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v);</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;../gtx/fast_square_root.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_normalize_dot 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_normalize_dot 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="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="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00205.html#gacb140a2b903115d318c8b0a2fb5a5daa">normalizeDot</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00205.html#ga2746fb9b5bd22b06b2f7c8babba5de9e">fastNormalizeDot</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; y);</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, qualifier P&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; GLM_FUNC_DECL mat&lt;3, 2, T, P&gt; <a class="code" href="a00212.html#ga7160ee2791f695fbc409e5dec7ad5548">diagonal3x2</a>(</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v);</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, qualifier P&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL mat&lt;3, 3, T, P&gt; <a class="code" href="a00212.html#ga246399c6803f8433bb097d81299b1535">diagonal3x3</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL mat&lt;3, 4, T, P&gt; <a class="code" href="a00212.html#gabd62dd6842db75540efe439e6af4f306">diagonal3x4</a>(</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; GLM_FUNC_DECL mat&lt;4, 2, T, P&gt; <a class="code" href="a00212.html#gad57a154d7d12d9cd006c9b03bd2adac6">diagonal4x2</a>(</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GLM_FUNC_DECL mat&lt;4, 3, T, P&gt; <a class="code" href="a00212.html#ga012fcff72e35891559ea33db736c0211">diagonal4x3</a>(</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; vec&lt;3, T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, P&gt; <a class="code" href="a00212.html#ga24d7a93eeaaac78b8e8cbc78b3804b23">diagonal4x4</a>(</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; vec&lt;4, T, P&gt; <span class="keyword">const</span> &amp; v);</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_operation.inl&quot;</span></div>
<div class="ttc" id="a00212_html_ga012fcff72e35891559ea33db736c0211"><div class="ttname"><a href="a00212.html#ga012fcff72e35891559ea33db736c0211">glm::diagonal4x3</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 3, T, P &gt; diagonal4x3(vec&lt; 3, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal 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="a00212_html_gabd62dd6842db75540efe439e6af4f306"><div class="ttname"><a href="a00212.html#gabd62dd6842db75540efe439e6af4f306">glm::diagonal3x4</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 3, 4, T, P &gt; diagonal3x4(vec&lt; 3, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_ga246399c6803f8433bb097d81299b1535"><div class="ttname"><a href="a00212.html#ga246399c6803f8433bb097d81299b1535">glm::diagonal3x3</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 3, 3, T, P &gt; diagonal3x3(vec&lt; 3, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_ga7160ee2791f695fbc409e5dec7ad5548"><div class="ttname"><a href="a00212.html#ga7160ee2791f695fbc409e5dec7ad5548">glm::diagonal3x2</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 3, 2, T, P &gt; diagonal3x2(vec&lt; 2, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_ga24d7a93eeaaac78b8e8cbc78b3804b23"><div class="ttname"><a href="a00212.html#ga24d7a93eeaaac78b8e8cbc78b3804b23">glm::diagonal4x4</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 4, T, P &gt; diagonal4x4(vec&lt; 4, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_ga2a5a236689e94ef72fcef64064e9bd5a"><div class="ttname"><a href="a00212.html#ga2a5a236689e94ef72fcef64064e9bd5a">glm::diagonal2x2</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 2, 2, T, P &gt; diagonal2x2(vec&lt; 2, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_gaba34be247fae13984a657f18f985b889"><div class="ttname"><a href="a00212.html#gaba34be247fae13984a657f18f985b889">glm::diagonal2x3</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 2, 3, T, P &gt; diagonal2x3(vec&lt; 2, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_gad57a154d7d12d9cd006c9b03bd2adac6"><div class="ttname"><a href="a00212.html#gad57a154d7d12d9cd006c9b03bd2adac6">glm::diagonal4x2</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 2, T, P &gt; diagonal4x2(vec&lt; 2, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="ttc" id="a00212_html_ga420b4c9e124eca9e4730e4d9f2ca04a6"><div class="ttname"><a href="a00212.html#ga420b4c9e124eca9e4730e4d9f2ca04a6">glm::diagonal2x4</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 2, 4, T, P &gt; diagonal2x4(vec&lt; 2, T, P &gt; const &amp;v)</div><div class="ttdoc">Build a diagonal matrix. </div></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#include &quot;normalize_dot.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="a00205_html_ga2746fb9b5bd22b06b2f7c8babba5de9e"><div class="ttname"><a href="a00205.html#ga2746fb9b5bd22b06b2f7c8babba5de9e">glm::fastNormalizeDot</a></div><div class="ttdeci">GLM_FUNC_DECL T fastNormalizeDot(vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</div><div class="ttdoc">Normalize parameters and returns the dot product of x and y. </div></div>
<div class="ttc" id="a00205_html_gacb140a2b903115d318c8b0a2fb5a5daa"><div class="ttname"><a href="a00205.html#gacb140a2b903115d318c8b0a2fb5a5daa">glm::normalizeDot</a></div><div class="ttdeci">GLM_FUNC_DECL T normalizeDot(vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</div><div class="ttdoc">Normalize parameters and returns the dot product of x and y. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>