mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

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

75
doc/api/a00076_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.7: matrix_query.hpp Source File</title>
<title>0.9.8: 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>
@@ -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>
@@ -46,57 +46,34 @@
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_query.hpp</div> </div>
<div class="title">normalize_dot.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00076.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="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#pragma once</span></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">#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_normalize_dot 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="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00213.html#gaffbc2f2cb15838de8886a68048f9004d">normalizeDot</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</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, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00213.html#ga8593b21bc2fe22184f01d5e08b5a2024">fastNormalizeDot</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;../gtx/vector_query.hpp&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</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="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_query extension included&quot;)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</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, precision P&gt;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga326de496972051413c7b44b85fc9cb6e">isNull</a>(tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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 <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga326de496972051413c7b44b85fc9cb6e">isNull</a>(tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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 <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga326de496972051413c7b44b85fc9cb6e">isNull</a>(tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>matType&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#gafc1ce12c738b8c5d007179e615609330">isIdentity</a>(matType&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, precision P&gt;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga934b673ec0e16d79eca0ca9dbb5d6d8b">isNormalized</a>(tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga934b673ec0e16d79eca0ca9dbb5d6d8b">isNormalized</a>(tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#ga934b673ec0e16d79eca0ca9dbb5d6d8b">isNormalized</a>(tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>matType&gt;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00212.html#gab2cb5d23df77b4e4e63ad2965acd31b3">isOrthogonal</a>(matType&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="preprocessor">#include &quot;matrix_query.inl&quot;</span></div>
<div class="ttc" id="a00212_html_ga326de496972051413c7b44b85fc9cb6e"><div class="ttname"><a href="a00212.html#ga326de496972051413c7b44b85fc9cb6e">glm::isNull</a></div><div class="ttdeci">GLM_FUNC_DECL bool isNull(tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is a null matrix. </div></div>
<div class="ttc" id="a00168_html_gacb41049b8d22c8aa90e362b96c524feb"><div class="ttname"><a href="a00168.html#gacb41049b8d22c8aa90e362b96c524feb">glm::epsilon</a></div><div class="ttdeci">GLM_FUNC_DECL genType epsilon()</div><div class="ttdoc">Return the epsilon constant for floating point types. </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="a00212_html_gafc1ce12c738b8c5d007179e615609330"><div class="ttname"><a href="a00212.html#gafc1ce12c738b8c5d007179e615609330">glm::isIdentity</a></div><div class="ttdeci">GLM_FUNC_DECL bool isIdentity(matType&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is an identity matrix. </div></div>
<div class="ttc" id="a00212_html_ga934b673ec0e16d79eca0ca9dbb5d6d8b"><div class="ttname"><a href="a00212.html#ga934b673ec0e16d79eca0ca9dbb5d6d8b">glm::isNormalized</a></div><div class="ttdeci">GLM_FUNC_DECL bool isNormalized(tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is a normalized matrix. </div></div>
<div class="ttc" id="a00212_html_gab2cb5d23df77b4e4e63ad2965acd31b3"><div class="ttname"><a href="a00212.html#gab2cb5d23df77b4e4e63ad2965acd31b3">glm::isOrthogonal</a></div><div class="ttdeci">GLM_FUNC_DECL bool isOrthogonal(matType&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is an orthonormalized matrix. </div></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;normalize_dot.inl&quot;</span></div>
<div class="ttc" id="a00213_html_gaffbc2f2cb15838de8886a68048f9004d"><div class="ttname"><a href="a00213.html#gaffbc2f2cb15838de8886a68048f9004d">glm::normalizeDot</a></div><div class="ttdeci">GLM_FUNC_DECL T normalizeDot(vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &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="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="a00213_html_ga8593b21bc2fe22184f01d5e08b5a2024"><div class="ttname"><a href="a00213.html#ga8593b21bc2fe22184f01d5e08b5a2024">glm::fastNormalizeDot</a></div><div class="ttdeci">GLM_FUNC_DECL T fastNormalizeDot(vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &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>