mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2018-05-08 13:51:58 +02:00
parent 4d4dbcade6
commit c3a41b0ef8
470 changed files with 72126 additions and 68787 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
doc/api/a00027_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: extended_min_max.hpp Source File</title>
<title>0.9.9 API documenation: extend.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>
@@ -85,7 +85,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">extended_min_max.hpp</div> </div>
<div class="title">extend.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00027.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>
@@ -95,100 +95,27 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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_extented_min_max 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="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_extend 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_extented_min_max extension included&quot;)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_extend 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="a00135.html">glm</a></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00138.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&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; T <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; T <span class="keyword">const</span>&amp; z);</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> genType&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00187.html#ga8140caae613b0f847ab0d7175dc03a37">extend</a>(</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; genType <span class="keyword">const</span>&amp; Origin,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; genType <span class="keyword">const</span>&amp; Source,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> Length);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; z);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; z);</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&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; T <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; T <span class="keyword">const</span>&amp; z, </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; T <span class="keyword">const</span>&amp; w);</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, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; z, </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; w);</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, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">min</a>(</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; z,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; w);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; T <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; T <span class="keyword">const</span>&amp; z);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; z);</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, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; z);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; T <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; T <span class="keyword">const</span>&amp; z, </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; T <span class="keyword">const</span>&amp; w);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; z, </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">typename</span> C&lt;T&gt;::T <span class="keyword">const</span>&amp; w);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>C&gt;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; GLM_FUNC_DECL C&lt;T&gt; <a class="code" href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">max</a>(</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; x, </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; y, </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; z, </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; C&lt;T&gt; <span class="keyword">const</span>&amp; w);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="preprocessor">#include &quot;extended_min_max.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="a00181_html_ga7471ea4159eed8dd9ea4ac5d46c2fead"><div class="ttname"><a href="a00181.html#ga7471ea4159eed8dd9ea4ac5d46c2fead">glm::min</a></div><div class="ttdeci">GLM_FUNC_DECL C&lt; T &gt; min(C&lt; T &gt; const &amp;x, C&lt; T &gt; const &amp;y, C&lt; T &gt; const &amp;z, C&lt; T &gt; const &amp;w)</div><div class="ttdoc">Return the minimum component-wise values of 4 inputs. </div></div>
<div class="ttc" id="a00181_html_gaacffbc466c2d08c140b181e7fd8a4858"><div class="ttname"><a href="a00181.html#gaacffbc466c2d08c140b181e7fd8a4858">glm::max</a></div><div class="ttdeci">GLM_FUNC_DECL C&lt; T &gt; max(C&lt; T &gt; const &amp;x, C&lt; T &gt; const &amp;y, C&lt; T &gt; const &amp;z, C&lt; T &gt; const &amp;w)</div><div class="ttdoc">Return the maximum component-wise values of 4 inputs. </div></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;extend.inl&quot;</span></div>
<div class="ttc" id="a00187_html_ga8140caae613b0f847ab0d7175dc03a37"><div class="ttname"><a href="a00187.html#ga8140caae613b0f847ab0d7175dc03a37">glm::extend</a></div><div class="ttdeci">GLM_FUNC_DECL genType extend(genType const &amp;Origin, genType const &amp;Source, typename genType::value_type const Length)</div><div class="ttdoc">Extends of Length the Origin position using the (Source - Origin) direction. </div></div>
<div class="ttc" id="a00138_html"><div class="ttname"><a href="a00138.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>