mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
doc/api/a00080_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.8"/>
<title>0.9.6: noise.hpp Source File</title>
<title>0.9.6: norm.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>
@@ -41,47 +41,84 @@
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_8aa733b201d3a9f98631fbccc86ae6c7.html">gtc</a></li> </ul>
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_5d3642ea3c7f2dae4a957f2cf472c9ae.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">noise.hpp</div> </div>
<div class="title">norm.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00080.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="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;../detail/precision.hpp&quot;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_noise extension included&quot;)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></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;</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, <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="l00059"></a><span class="lineno"> 59</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00173.html#ga7e103ffffacb322fe2d4863c372ae2fd">perlin</a>(</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; p);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</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="l00065"></a><span class="lineno"> 65</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00173.html#ga7e103ffffacb322fe2d4863c372ae2fd">perlin</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; p,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; rep);</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, <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="l00072"></a><span class="lineno"> 72</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00173.html#ga05f5ab240c9a3fdeee353636e464c285">simplex</a>(</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; p);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#include &quot;noise.inl&quot;</span></div>
<div class="ttc" id="a00173_html_ga05f5ab240c9a3fdeee353636e464c285"><div class="ttname"><a href="a00173.html#ga05f5ab240c9a3fdeee353636e464c285">glm::simplex</a></div><div class="ttdeci">GLM_FUNC_DECL T simplex(vecType&lt; T, P &gt; const &amp;p)</div><div class="ttdoc">Simplex noise. </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#l00031">_noise.hpp:31</a></div></div>
<div class="ttc" id="a00173_html_ga7e103ffffacb322fe2d4863c372ae2fd"><div class="ttname"><a href="a00173.html#ga7e103ffffacb322fe2d4863c372ae2fd">glm::perlin</a></div><div class="ttdeci">GLM_FUNC_DECL T perlin(vecType&lt; T, P &gt; const &amp;p, vecType&lt; T, P &gt; const &amp;rep)</div><div class="ttdoc">Periodic perlin noise. </div></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="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/quaternion.hpp&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_norm extension included&quot;)</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></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;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#gaa279ba7fdecbed3f9f2b60502b7ec8ca">length2</a>(</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; T <span class="keyword">const</span> &amp; x);</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> genType&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; GLM_FUNC_DECL <span class="keyword">typename</span> genType::value_type <a class="code" href="a00212.html#gaa279ba7fdecbed3f9f2b60502b7ec8ca">length2</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; genType <span class="keyword">const</span> &amp; x);</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&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#gaec2d9df62436879b48207d39516f3788">distance2</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; T <span class="keyword">const</span> &amp; p0,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; T <span class="keyword">const</span> &amp; p1);</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; GLM_FUNC_DECL <span class="keyword">typename</span> genType::value_type <a class="code" href="a00212.html#gaec2d9df62436879b48207d39516f3788">distance2</a>(</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; genType <span class="keyword">const</span> &amp; p0,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; genType <span class="keyword">const</span> &amp; p1);</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 T <a class="code" href="a00212.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a>(</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</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; GLM_FUNC_DECL T <a class="code" href="a00212.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a>(</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a>(</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a>(</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</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, precision P&gt;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a>(</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00212.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a>(</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="preprocessor">#include &quot;norm.inl&quot;</span></div>
<div class="ttc" id="a00212_html_gaec2d9df62436879b48207d39516f3788"><div class="ttname"><a href="a00212.html#gaec2d9df62436879b48207d39516f3788">glm::distance2</a></div><div class="ttdeci">GLM_FUNC_DECL genType::value_type distance2(genType const &amp;p0, genType const &amp;p1)</div><div class="ttdoc">Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </div></div>
<div class="ttc" id="a00212_html_gaa279ba7fdecbed3f9f2b60502b7ec8ca"><div class="ttname"><a href="a00212.html#gaa279ba7fdecbed3f9f2b60502b7ec8ca">glm::length2</a></div><div class="ttdeci">GLM_FUNC_DECL genType::value_type length2(genType const &amp;x)</div><div class="ttdoc">Returns the squared length of x. </div></div>
<div class="ttc" id="a00212_html_ga0a8cb8a0ce88d1d977de23209bf04610"><div class="ttname"><a href="a00212.html#ga0a8cb8a0ce88d1d977de23209bf04610">glm::l2Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l2Norm(tvec3&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the L2 norm of v. </div></div>
<div class="ttc" id="a00212_html_ga6d5964f09cdb43803496a5ee3ced71cb"><div class="ttname"><a href="a00212.html#ga6d5964f09cdb43803496a5ee3ced71cb">glm::l1Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l1Norm(tvec3&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Returns the L1 norm of v. </div></div>
<div class="ttc" id="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></div></div>
<div class="ttc" id="a00212_html_gaab931b0d1acfe2f9c1cb78311edf24fc"><div class="ttname"><a href="a00212.html#gaab931b0d1acfe2f9c1cb78311edf24fc">glm::lxNorm</a></div><div class="ttdeci">GLM_FUNC_DECL T lxNorm(tvec3&lt; T, P &gt; const &amp;x, unsigned int Depth)</div><div class="ttdoc">Returns the L norm of v. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>