mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygem documentation

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

71
doc/api/a00147_source.html
View File

@@ -67,55 +67,36 @@
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">namespace </span>glm</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; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga5988c0d52c89370fcc3fee4eaf0a2dd8">areCollinear</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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> genType&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#gac9743adb82a3a94693b1693092ae7dca">areOrthogonal</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">typename</span> genType::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> genType, 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="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; vecType&lt;genType, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; genType <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; detail::tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, 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="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga4d8f51cd35294c694bbe8dec1bec03d8">areCollinear</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v0, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</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="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga671834ed100b138c176f3d91dd080c34">areOrthogonal</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v0, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</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="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, <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="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</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, <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="l00078"></a><span class="lineno"> 78</span>&#160; vecType&lt;bool, P&gt; <a class="code" href="a00235.html#ga8281979eb4a14f05c38a1225ea9933ba">isCompNull</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</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="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga05ced31444ad895682e811fcc94f35bd">areOrthonormal</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v0, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga3fd2c8a48c2d9d3e208bdfed6aafca6e">areOrthonormal</a>(</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="preprocessor">#include &quot;vector_query.inl&quot;</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="preprocessor">#endif//GLM_GTX_vector_query</span></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;vector_query.inl&quot;</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif//GLM_GTX_vector_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="a00235_html_ga05ced31444ad895682e811fcc94f35bd"><div class="ttname"><a href="a00235.html#ga05ced31444ad895682e811fcc94f35bd">glm::areOrthonormal</a></div><div class="ttdeci">bool areOrthonormal(vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthonormal. </div></div>
<div class="ttc" id="a00235_html_ga671834ed100b138c176f3d91dd080c34"><div class="ttname"><a href="a00235.html#ga671834ed100b138c176f3d91dd080c34">glm::areOrthogonal</a></div><div class="ttdeci">bool areOrthogonal(vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthogonals. </div></div>
<div class="ttc" id="a00235_html_ga4d8f51cd35294c694bbe8dec1bec03d8"><div class="ttname"><a href="a00235.html#ga4d8f51cd35294c694bbe8dec1bec03d8">glm::areCollinear</a></div><div class="ttdeci">bool areCollinear(vecType&lt; T, P &gt; const &amp;v0, vecType&lt; T, P &gt; const &amp;v1, T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are collinears. </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="a00235_html_gac9743adb82a3a94693b1693092ae7dca"><div class="ttname"><a href="a00235.html#gac9743adb82a3a94693b1693092ae7dca">glm::areOrthogonal</a></div><div class="ttdeci">bool areOrthogonal(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthogonals. </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="a00235_html_ga5988c0d52c89370fcc3fee4eaf0a2dd8"><div class="ttname"><a href="a00235.html#ga5988c0d52c89370fcc3fee4eaf0a2dd8">glm::areCollinear</a></div><div class="ttdeci">bool areCollinear(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are collinears. </div></div>
<div class="ttc" id="a00235_html_ga3fd2c8a48c2d9d3e208bdfed6aafca6e"><div class="ttname"><a href="a00235.html#ga3fd2c8a48c2d9d3e208bdfed6aafca6e">glm::areOrthonormal</a></div><div class="ttdeci">bool areOrthonormal(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthonormal. </div></div>
<div class="ttc" id="a00235_html_ga8281979eb4a14f05c38a1225ea9933ba"><div class="ttname"><a href="a00235.html#ga8281979eb4a14f05c38a1225ea9933ba">glm::isCompNull</a></div><div class="ttdeci">vecType&lt; bool, P &gt; isCompNull(vecType&lt; T, P &gt; const &amp;v, T const &amp;epsilon)</div><div class="ttdoc">Check whether a each component of a vector is null. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>