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

83
doc/api/a00187.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: GLM_GTX_gradient_paint</title>
<title>0.9.9 API documenation: GLM_GTX_extend</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>
@@ -78,49 +78,45 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_gradient_paint<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
<div class="title">GLM_GTX_extend<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Include &lt;<a class="el" href="a00036.html" title="GLM_GTX_gradient_paint ">glm/gtx/gradient_paint.hpp</a>&gt; to use the features of this extension.
<p>Include &lt;<a class="el" href="a00027.html" title="GLM_GTX_extend ">glm/gtx/extend.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga849241df1e55129b8ce9476200307419"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga849241df1e55129b8ce9476200307419"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#ga849241df1e55129b8ce9476200307419">linearGradient</a> (vec&lt; 2, T, Q &gt; const &amp;Point0, vec&lt; 2, T, Q &gt; const &amp;Point1, vec&lt; 2, T, Q &gt; const &amp;Position)</td></tr>
<tr class="memdesc:ga849241df1e55129b8ce9476200307419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a color from a linear gradient. <a href="a00187.html#ga849241df1e55129b8ce9476200307419">More...</a><br /></td></tr>
<tr class="separator:ga849241df1e55129b8ce9476200307419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaecb1e93de4cbe0758b882812d4da294"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaaecb1e93de4cbe0758b882812d4da294"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gaaecb1e93de4cbe0758b882812d4da294">radialGradient</a> (vec&lt; 2, T, Q &gt; const &amp;Center, T const &amp;Radius, vec&lt; 2, T, Q &gt; const &amp;Focal, vec&lt; 2, T, Q &gt; const &amp;Position)</td></tr>
<tr class="memdesc:gaaecb1e93de4cbe0758b882812d4da294"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a color from a radial gradient. <a href="a00187.html#gaaecb1e93de4cbe0758b882812d4da294">More...</a><br /></td></tr>
<tr class="separator:gaaecb1e93de4cbe0758b882812d4da294"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8140caae613b0f847ab0d7175dc03a37"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga8140caae613b0f847ab0d7175dc03a37"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#ga8140caae613b0f847ab0d7175dc03a37">extend</a> (genType const &amp;Origin, genType const &amp;Source, typename genType::value_type const Length)</td></tr>
<tr class="memdesc:ga8140caae613b0f847ab0d7175dc03a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extends of Length the Origin position using the (Source - Origin) direction. <a href="a00187.html#ga8140caae613b0f847ab0d7175dc03a37">More...</a><br /></td></tr>
<tr class="separator:ga8140caae613b0f847ab0d7175dc03a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;<a class="el" href="a00036.html" title="GLM_GTX_gradient_paint ">glm/gtx/gradient_paint.hpp</a>&gt; to use the features of this extension. </p>
<p>Functions that return the color of procedural gradient for specific coordinates. </p>
<p>Include &lt;<a class="el" href="a00027.html" title="GLM_GTX_extend ">glm/gtx/extend.hpp</a>&gt; to use the features of this extension. </p>
<p>Extend a position from a source to a position at a defined length. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga849241df1e55129b8ce9476200307419"></a>
<a class="anchor" id="ga8140caae613b0f847ab0d7175dc03a37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::linearGradient </td>
<td class="memname">GLM_FUNC_DECL genType glm::extend </td>
<td>(</td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point0</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Origin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point1</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Position</em>&#160;</td>
<td class="paramtype">typename genType::value_type const&#160;</td>
<td class="paramname"><em>Length</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -130,49 +126,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a color from a linear gradient. </p>
<dl class="section see"><dt>See also</dt><dd>- <a class="el" href="a00187.html" title="Include <glm/gtx/gradient_paint.hpp> to use the features of this extension. ">GLM_GTX_gradient_paint</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaaecb1e93de4cbe0758b882812d4da294"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::radialGradient </td>
<td>(</td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Center</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>Radius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Focal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Position</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a color from a radial gradient. </p>
<dl class="section see"><dt>See also</dt><dd>- <a class="el" href="a00187.html" title="Include <glm/gtx/gradient_paint.hpp> to use the features of this extension. ">GLM_GTX_gradient_paint</a> </dd></dl>
<p>Extends of Length the Origin position using the (Source - Origin) direction. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00187.html" title="Include <glm/gtx/extend.hpp> to use the features of this extension. ">GLM_GTX_extend</a> </dd></dl>
</div>
</div>