mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen API doc

Browse Source
This commit is contained in:
Christophe Riccio
2016-11-13 00:39:32 +01:00
parent 83d14ee411
commit d8ca117cb6
394 changed files with 48595 additions and 40958 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
doc/api/a00041_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.8: gradient_paint.hpp Source File</title>
<title>0.9.8 API documenation: glm.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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.8
<div id="projectname">0.9.8 API documenation
</div>
</td>
</tr>
@@ -41,47 +41,74 @@
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_8d176b5b7dd0ae42ea6876078f2bde49.html">gtx</a></li> </ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">gradient_paint.hpp</div> </div>
<div class="title">glm.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00041.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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#pragma once</span></div>
<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">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_gradient_paint extension included&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="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</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; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00196.html#ga166d43d567a4cf150579a92f69b0dc9f">radialGradient</a>(</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Center,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; T <span class="keyword">const</span> &amp; Radius,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Focal,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Position);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00196.html#gacde26d5e0c4a1856467bded9dfad9040">linearGradient</a>(</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Point0,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Point1,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; Position);</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;gradient_paint.inl&quot;</span></div>
<div class="ttc" id="a00141_html"><div class="ttname"><a href="a00141.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="a00196_html_gacde26d5e0c4a1856467bded9dfad9040"><div class="ttname"><a href="a00196.html#gacde26d5e0c4a1856467bded9dfad9040">glm::linearGradient</a></div><div class="ttdeci">GLM_FUNC_DECL T linearGradient(tvec2&lt; T, P &gt; const &amp;Point0, tvec2&lt; T, P &gt; const &amp;Point1, tvec2&lt; T, P &gt; const &amp;Position)</div><div class="ttdoc">Return a color from a linear gradient. </div></div>
<div class="ttc" id="a00196_html_ga166d43d567a4cf150579a92f69b0dc9f"><div class="ttname"><a href="a00196.html#ga166d43d567a4cf150579a92f69b0dc9f">glm::radialGradient</a></div><div class="ttdeci">GLM_FUNC_DECL T radialGradient(tvec2&lt; T, P &gt; const &amp;Center, T const &amp;Radius, tvec2&lt; T, P &gt; const &amp;Focal, tvec2&lt; T, P &gt; const &amp;Position)</div><div class="ttdoc">Return a color from a radial gradient. </div></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00002.html">detail/_fixes.hpp</a>&quot;</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#include &lt;climits&gt;</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#include &lt;cfloat&gt;</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#include &lt;cassert&gt;</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00039.html">fwd.hpp</a>&quot;</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_MESSAGE_CORE_INCLUDED_DISPLAYED)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor"># define GLM_MESSAGE_CORE_INCLUDED_DISPLAYED</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: Core library included&quot;)</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#endif//GLM_MESSAGES</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00132.html">vec2.hpp</a>&quot;</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00133.html">vec3.hpp</a>&quot;</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00134.html">vec4.hpp</a>&quot;</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00052.html">mat2x2.hpp</a>&quot;</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00053.html">mat2x3.hpp</a>&quot;</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00054.html">mat2x4.hpp</a>&quot;</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00055.html">mat3x2.hpp</a>&quot;</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00056.html">mat3x3.hpp</a>&quot;</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00057.html">mat3x4.hpp</a>&quot;</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00058.html">mat4x2.hpp</a>&quot;</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00059.html">mat4x3.hpp</a>&quot;</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00060.html">mat4x4.hpp</a>&quot;</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00105.html">trigonometric.hpp</a>&quot;</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00023.html">exponential.hpp</a>&quot;</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00015.html">common.hpp</a>&quot;</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00082.html">packing.hpp</a>&quot;</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00040.html">geometric.hpp</a>&quot;</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00061.html">matrix.hpp</a>&quot;</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00138.html">vector_relational.hpp</a>&quot;</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00047.html">integer.hpp</a>&quot;</span></div>
<div class="ttc" id="a00039_html"><div class="ttname"><a href="a00039.html">fwd.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00056_html"><div class="ttname"><a href="a00056.html">mat3x3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00015_html"><div class="ttname"><a href="a00015.html">common.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00059_html"><div class="ttname"><a href="a00059.html">mat4x3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00047_html"><div class="ttname"><a href="a00047.html">integer.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00023_html"><div class="ttname"><a href="a00023.html">exponential.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00055_html"><div class="ttname"><a href="a00055.html">mat3x2.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00082_html"><div class="ttname"><a href="a00082.html">packing.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00138_html"><div class="ttname"><a href="a00138.html">vector_relational.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00061_html"><div class="ttname"><a href="a00061.html">matrix.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00058_html"><div class="ttname"><a href="a00058.html">mat4x2.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00134_html"><div class="ttname"><a href="a00134.html">vec4.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00105_html"><div class="ttname"><a href="a00105.html">trigonometric.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00132_html"><div class="ttname"><a href="a00132.html">vec2.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00054_html"><div class="ttname"><a href="a00054.html">mat2x4.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00052_html"><div class="ttname"><a href="a00052.html">mat2x2.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00040_html"><div class="ttname"><a href="a00040.html">geometric.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00057_html"><div class="ttname"><a href="a00057.html">mat3x4.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00133_html"><div class="ttname"><a href="a00133.html">vec3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00060_html"><div class="ttname"><a href="a00060.html">mat4x4.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00053_html"><div class="ttname"><a href="a00053.html">mat2x3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00002_html"><div class="ttname"><a href="a00002.html">_fixes.hpp</a></div><div class="ttdoc">GLM Core </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>