Updated doxygem documentation

This commit is contained in:
Christophe Riccio
2014-01-11 23:35:39 +01:00
parent 6335627796
commit cfbd6e43b2
166 changed files with 4147 additions and 3981 deletions

View File

@@ -68,55 +68,39 @@
<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;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; detail::tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);</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; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; detail::tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);</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; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; detail::tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);</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; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gabedf650c2fb3a6062d96dd979b809f51">isIdentity</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; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;typename genType::value_type&gt;::epsilon()*/</span>);</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; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; detail::tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(detail::tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, precision P&gt;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(detail::tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(detail::tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</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="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#ga95004e68e8d77a8b37038d96c088ec9c">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="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(detail::tmat2x2&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, precision P&gt;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(detail::tmat3x3&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(detail::tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; detail::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; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;valType&gt;::epsilon()*/</span>);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; detail::tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;valType&gt;::epsilon()*/</span>);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</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="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#ga4fe1957e1f5935a9b7b6e61417d41aa4">isOrthogonal</a>(</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; matType&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a><span class="comment">/* = std::numeric_limits&lt;genType&gt;::epsilon()*/</span>);</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_query.inl&quot;</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="preprocessor">#endif//GLM_GTX_matrix_query</span></div>
<div class="ttc" id="a00210_html_gabedf650c2fb3a6062d96dd979b809f51"><div class="ttname"><a href="a00210.html#gabedf650c2fb3a6062d96dd979b809f51">glm::isIdentity</a></div><div class="ttdeci">bool isIdentity(genType const &amp;m, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is an identity matrix. </div></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, <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="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#ga4fe1957e1f5935a9b7b6e61417d41aa4">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="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="preprocessor">#include &quot;matrix_query.inl&quot;</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="preprocessor">#endif//GLM_GTX_matrix_query</span></div>
<div class="ttc" id="a00171_html_gacb41049b8d22c8aa90e362b96c524feb"><div class="ttname"><a href="a00171.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="a00210_html_ga4fe1957e1f5935a9b7b6e61417d41aa4"><div class="ttname"><a href="a00210.html#ga4fe1957e1f5935a9b7b6e61417d41aa4">glm::isOrthogonal</a></div><div class="ttdeci">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="ttc" id="a00210_html_gaeb6ab065655de7ae74220c893181b682"><div class="ttname"><a href="a00210.html#gaeb6ab065655de7ae74220c893181b682">glm::isNormalized</a></div><div class="ttdeci">bool isNormalized(detail::tmat2x2&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="a00210_html_gaca2ae6e3b473e36c0bf0fcf50d0b972b"><div class="ttname"><a href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">glm::isNull</a></div><div class="ttdeci">bool isNull(detail::tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix a null matrix. </div></div>
<div class="ttc" id="a00210_html_ga95004e68e8d77a8b37038d96c088ec9c"><div class="ttname"><a href="a00210.html#ga95004e68e8d77a8b37038d96c088ec9c">glm::isIdentity</a></div><div class="ttdeci">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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>