mewin/glm
1
0
Fork 0
Code Releases Activity

Updated documentation

Browse Source
This commit is contained in:
Christophe Riccio
2012-11-18 14:05:52 +01:00
parent 5474e33d08
commit 753d5db251
389 changed files with 47803 additions and 49899 deletions
Download Patch File Download Diff File Expand all files Collapse all files

253
doc/api/a00203.html
View File

@@ -2,189 +2,206 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTX_std_based_type: Add types based on STL</title>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_spline</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</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_std_based_type: Add types based on STL</div> </div>
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
<div class="title">GLM_GTX_spline</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec2<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gacbf0e575318aca3cd45bb4bad637304e">size2</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec2<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga42cd32d2878dce26a80cadf178644971">size2_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec3<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gaf6ba9ab795603c29fcf936590b8625dc">size3</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec3<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#ga807dcee18151d7c571854b73e6565078">size3_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec4<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gaf03358a7015ae5e67e9f4de117872191">size4</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec4<br class="typebreak"/>
&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00203.html#gac4e9d285f48a71eb9eff1872b7396b57">size4_t</a></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga392c457b16903889ff080038772f6ef2"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga392c457b16903889ff080038772f6ef2"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga392c457b16903889ff080038772f6ef2">catmullRom</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga392c457b16903889ff080038772f6ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga1ce22b5ceec4df8c6022990058bcf215">cubic</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga19e4a66ad17ebedc6b8250e8751e7624">hermite</a> (genType const &amp;v1, genType const &amp;t1, genType const &amp;v2, genType const &amp;t2, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Adds vector types based on STL value types. </p>
<p>&lt;<a class="el" href="a00087.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/std_based_type.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gacbf0e575318aca3cd45bb4bad637304e"></a><!-- doxytag: member="glm::size2" ref="gacbf0e575318aca3cd45bb4bad637304e" args="" -->
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Spline functions. </p>
<p>&lt;<a class="el" href="a00087.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/spline.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga392c457b16903889ff080038772f6ef2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec2&lt;std::size_t&gt; size2</td>
<td class="memname">genType glm::catmullRom </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Vector type based of two std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00056">56</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
<p>Return a point from a catmull rom curve. </p>
<p>From GLM_GTX_spline extension. </p>
</div>
</div>
<a class="anchor" id="ga42cd32d2878dce26a80cadf178644971"></a><!-- doxytag: member="glm::size2_t" ref="ga42cd32d2878dce26a80cadf178644971" args="" -->
<a class="anchor" id="ga1ce22b5ceec4df8c6022990058bcf215"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec2&lt;std::size_t&gt; size2_t</td>
<td class="memname">genType glm::cubic </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Vector type based of two std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00068">68</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
<p>Return a point from a cubic curve. </p>
<p>From GLM_GTX_spline extension. </p>
</div>
</div>
<a class="anchor" id="gaf6ba9ab795603c29fcf936590b8625dc"></a><!-- doxytag: member="glm::size3" ref="gaf6ba9ab795603c29fcf936590b8625dc" args="" -->
<a class="anchor" id="ga19e4a66ad17ebedc6b8250e8751e7624"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec3&lt;std::size_t&gt; size3</td>
<td class="memname">genType glm::hermite </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Vector type based of three std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00060">60</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga807dcee18151d7c571854b73e6565078"></a><!-- doxytag: member="glm::size3_t" ref="ga807dcee18151d7c571854b73e6565078" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec3&lt;std::size_t&gt; size3_t</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t1</em>, </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Vector type based of three std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00072">72</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaf03358a7015ae5e67e9f4de117872191"></a><!-- doxytag: member="glm::size4" ref="gaf03358a7015ae5e67e9f4de117872191" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec4&lt;std::size_t&gt; size4</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Vector type based of four std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00064">64</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gac4e9d285f48a71eb9eff1872b7396b57"></a><!-- doxytag: member="glm::size4_t" ref="gac4e9d285f48a71eb9eff1872b7396b57" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::tvec4&lt;std::size_t&gt; size4_t</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Vector type based of four std::size_t components. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>- GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00087_source.html#l00076">76</a> of file <a class="el" href="a00087_source.html">std_based_type.hpp</a>.</p>
<p>Return a point from a hermite curve. </p>
<p>From GLM_GTX_spline extension. </p>
</div>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<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.7.5.1
</a> 1.8.2
</small></address>
</body>
</html>