mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
doc/api/a00199.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_raw_data</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_gradient_paint</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>
@@ -15,110 +16,121 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_raw_data</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_gradient_paint<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4a5def5e5e8468de8e97132ddf5c72c5"><td class="memItemLeft" align="right" valign="top">typedef uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00199.html#ga4a5def5e5e8468de8e97132ddf5c72c5">byte</a></td></tr>
<tr class="separator:ga4a5def5e5e8468de8e97132ddf5c72c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga162201f4386c2973e6ebd76ac0941de0"><td class="memItemLeft" align="right" valign="top">typedef uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00199.html#ga162201f4386c2973e6ebd76ac0941de0">dword</a></td></tr>
<tr class="separator:ga162201f4386c2973e6ebd76ac0941de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7872fb6c3bcddc8658fe3209f04d275"><td class="memItemLeft" align="right" valign="top">typedef uint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00199.html#gab7872fb6c3bcddc8658fe3209f04d275">qword</a></td></tr>
<tr class="separator:gab7872fb6c3bcddc8658fe3209f04d275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9599d4794d33c5d5d07675b5250b74bd"><td class="memItemLeft" align="right" valign="top">typedef uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00199.html#ga9599d4794d33c5d5d07675b5250b74bd">word</a></td></tr>
<tr class="separator:ga9599d4794d33c5d5d07675b5250b74bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#gab2d6e851946cd10ea42e75d64dbcdfc7">linearGradient</a> (detail::tvec2&lt; T, P &gt; const &amp;Point0, detail::tvec2&lt; T, P &gt; const &amp;Point1, detail::tvec2&lt; T, P &gt; const &amp;Position)</td></tr>
<tr class="separator:gab2d6e851946cd10ea42e75d64dbcdfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00199.html#ga0b1e049844c0627a03907d4a8bcde13f">radialGradient</a> (detail::tvec2&lt; T, P &gt; const &amp;Center, T const &amp;Radius, detail::tvec2&lt; T, P &gt; const &amp;Focal, detail::tvec2&lt; T, P &gt; const &amp;Position)</td></tr>
<tr class="separator:ga0b1e049844c0627a03907d4a8bcde13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Projection of a vector to other one. </p>
<p>&lt;<a class="el" href="a00080.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/raw_data.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4a5def5e5e8468de8e97132ddf5c72c5"></a>
<p>Functions that return the color of procedural gradient for specific coordinates. </p>
<p>&lt;<a class="el" href="a00044.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/gradient_paint.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab2d6e851946cd10ea42e75d64dbcdfc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint8 byte</td>
<td class="memname">T glm::linearGradient </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Point1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &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>Type for byte numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00080_source.html#l00056">56</a> of file <a class="el" href="a00080_source.html">raw_data.hpp</a>.</p>
<p>Return a color from a linear gradient. </p>
<dl class="section see"><dt>See Also</dt><dd>- <a class="el" href="a00199.html" title="Functions that return the color of procedural gradient for specific coordinates. ">GLM_GTX_gradient_paint</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga162201f4386c2973e6ebd76ac0941de0"></a>
<a class="anchor" id="ga0b1e049844c0627a03907d4a8bcde13f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32 dword</td>
<td class="memname">T glm::radialGradient </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Center</em>, </td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for dword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00080_source.html#l00064">64</a> of file <a class="el" href="a00080_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gab7872fb6c3bcddc8658fe3209f04d275"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint64 qword</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>Radius</em>, </td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for qword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00080_source.html#l00068">68</a> of file <a class="el" href="a00080_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga9599d4794d33c5d5d07675b5250b74bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint16 word</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Focal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec2&lt; T, P &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>Type for word numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00080_source.html#l00060">60</a> of file <a class="el" href="a00080_source.html">raw_data.hpp</a>.</p>
<p>Return a color from a radial gradient. </p>
<dl class="section see"><dt>See Also</dt><dd>- <a class="el" href="a00199.html" title="Functions that return the color of procedural gradient for specific coordinates. ">GLM_GTX_gradient_paint</a> </dd></dl>
</div>
</div>
@@ -127,7 +139,7 @@ Typedefs</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</a> 1.8.5
</small></address>
</body>
</html>