mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
doc/api/a00044_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: gradient_paint.hpp Source File</title>
<title>0.9.9 API documenation: log_base.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>
@@ -84,7 +84,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">gradient_paint.hpp</div> </div>
<div class="title">log_base.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00044.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>
@@ -92,38 +92,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// Dependency:</span></div>
<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;<span class="preprocessor">#include &quot;../gtx/optimum_pow.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">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_gradient_paint 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="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="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_gradient_paint extension included&quot;)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00200.html#ga92318869b2cef1542860d3d98ecf3f7e">radialGradient</a>(</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Center,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; T <span class="keyword">const</span> &amp; Radius,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Focal,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Position);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00200.html#ga68fcdcca61476acf71a988495d64e971">linearGradient</a>(</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Point0,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Point1,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; vec&lt;2, T, P&gt; <span class="keyword">const</span> &amp; Position);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#include &quot;gradient_paint.inl&quot;</span></div>
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.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="a00200_html_ga92318869b2cef1542860d3d98ecf3f7e"><div class="ttname"><a href="a00200.html#ga92318869b2cef1542860d3d98ecf3f7e">glm::radialGradient</a></div><div class="ttdeci">GLM_FUNC_DECL T radialGradient(vec&lt; 2, T, P &gt; const &amp;Center, T const &amp;Radius, vec&lt; 2, T, P &gt; const &amp;Focal, vec&lt; 2, T, P &gt; const &amp;Position)</div><div class="ttdoc">Return a color from a radial gradient. </div></div>
<div class="ttc" id="a00200_html_ga68fcdcca61476acf71a988495d64e971"><div class="ttname"><a href="a00200.html#ga68fcdcca61476acf71a988495d64e971">glm::linearGradient</a></div><div class="ttdeci">GLM_FUNC_DECL T linearGradient(vec&lt; 2, T, P &gt; const &amp;Point0, vec&lt; 2, T, P &gt; const &amp;Point1, vec&lt; 2, T, P &gt; const &amp;Position)</div><div class="ttdoc">Return a color from a linear gradient. </div></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_log_base 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_log_base 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="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> genType&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00193.html#ga60a7b0a401da660869946b2b77c710c9">log</a>(</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; genType <span class="keyword">const</span>&amp; x,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; genType <span class="keyword">const</span>&amp; base);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00193.html#ga04ef803a24f3d4f8c67dbccb33b0fce0">sign</a>(</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; base);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#include &quot;log_base.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="a00193_html_ga04ef803a24f3d4f8c67dbccb33b0fce0"><div class="ttname"><a href="a00193.html#ga04ef803a24f3d4f8c67dbccb33b0fce0">glm::sign</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, Q &gt; sign(vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;base)</div><div class="ttdoc">Logarithm for any base. </div></div>
<div class="ttc" id="a00193_html_ga60a7b0a401da660869946b2b77c710c9"><div class="ttname"><a href="a00193.html#ga60a7b0a401da660869946b2b77c710c9">glm::log</a></div><div class="ttdeci">GLM_FUNC_DECL genType log(genType const &amp;x, genType const &amp;base)</div><div class="ttdoc">Logarithm for any base. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>