Updated API

This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions

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.8"/>
<title>0.9.6: GLM_GTX_std_based_type</title>
<title>0.9.6: GLM_GTX_transform</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>
@@ -37,176 +37,98 @@
</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<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_transform<div class="ingroups"><a class="el" href="a00159.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:ga47c940f279a6b97ffc301eb4526a445a"><td class="memItemLeft" align="right" valign="top">typedef tvec1&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#ga47c940f279a6b97ffc301eb4526a445a">size1</a></td></tr>
<tr class="separator:ga47c940f279a6b97ffc301eb4526a445a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga77d0b061efa41cb2ed2285d09294314e"><td class="memItemLeft" align="right" valign="top">typedef tvec1&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#ga77d0b061efa41cb2ed2285d09294314e">size1_t</a></td></tr>
<tr class="separator:ga77d0b061efa41cb2ed2285d09294314e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0ef172641a1555684da0beb735c2a79"><td class="memItemLeft" align="right" valign="top">typedef tvec2&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#gac0ef172641a1555684da0beb735c2a79">size2</a></td></tr>
<tr class="separator:gac0ef172641a1555684da0beb735c2a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7d72bbe318d27da9d30f27095e4c75e"><td class="memItemLeft" align="right" valign="top">typedef tvec2&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#gaa7d72bbe318d27da9d30f27095e4c75e">size2_t</a></td></tr>
<tr class="separator:gaa7d72bbe318d27da9d30f27095e4c75e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51b5e9650c459973134ffb4236ae88b6"><td class="memItemLeft" align="right" valign="top">typedef tvec3&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#ga51b5e9650c459973134ffb4236ae88b6">size3</a></td></tr>
<tr class="separator:ga51b5e9650c459973134ffb4236ae88b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad364e6c302642e3bb89d756df5d0c8c6"><td class="memItemLeft" align="right" valign="top">typedef tvec3&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#gad364e6c302642e3bb89d756df5d0c8c6">size3_t</a></td></tr>
<tr class="separator:gad364e6c302642e3bb89d756df5d0c8c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf07a3f432e328c99d35637225c988121"><td class="memItemLeft" align="right" valign="top">typedef tvec4&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#gaf07a3f432e328c99d35637225c988121">size4</a></td></tr>
<tr class="separator:gaf07a3f432e328c99d35637225c988121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06862b7d59094244025d34407b2cb796"><td class="memItemLeft" align="right" valign="top">typedef tvec4&lt; std::size_t, <br class="typebreak" />
defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00233.html#ga06862b7d59094244025d34407b2cb796">size4_t</a></td></tr>
<tr class="separator:ga06862b7d59094244025d34407b2cb796"><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:ga2020c91bf61e050882b3a5c18eada700"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga2020c91bf61e050882b3a5c18eada700"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga2020c91bf61e050882b3a5c18eada700">rotate</a> (T angle, tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga2020c91bf61e050882b3a5c18eada700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1972d4a66a2e92637c8aaee598417a71"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga1972d4a66a2e92637c8aaee598417a71"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga1972d4a66a2e92637c8aaee598417a71">scale</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga1972d4a66a2e92637c8aaee598417a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga838c4505ef7f254ed05117b1ac9691fb">translate</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga838c4505ef7f254ed05117b1ac9691fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Adds vector types based on STL value types. </p>
<p>&lt;<a class="el" href="a00110.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>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga47c940f279a6b97ffc301eb4526a445a"></a>
<p>Add transformation matrices. </p>
<p>&lt;<a class="el" href="a00111.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/transform.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga2020c91bf61e050882b3a5c18eada700"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec1&lt;std::size_t, defaultp&gt; size1</td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of one std::size_t component. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00055">55</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
<p>Builds a rotation 4 * 4 matrix created from an axis of 3 scalars and an angle expressed in degrees. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00171.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00233.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga77d0b061efa41cb2ed2285d09294314e"></a>
<a class="anchor" id="ga1972d4a66a2e92637c8aaee598417a71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec1&lt;std::size_t, defaultp&gt; size1_t</td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::scale </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of one std::size_t component. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00071">71</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
<p>Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00171.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00233.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac0ef172641a1555684da0beb735c2a79"></a>
<a class="anchor" id="ga838c4505ef7f254ed05117b1ac9691fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec2&lt;std::size_t, defaultp&gt; size2</td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::translate </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of two std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00059">59</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaa7d72bbe318d27da9d30f27095e4c75e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec2&lt;std::size_t, defaultp&gt; size2_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of two std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00075">75</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga51b5e9650c459973134ffb4236ae88b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec3&lt;std::size_t, defaultp&gt; size3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of three std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00063">63</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gad364e6c302642e3bb89d756df5d0c8c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec3&lt;std::size_t, defaultp&gt; size3_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of three std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00079">79</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaf07a3f432e328c99d35637225c988121"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec4&lt;std::size_t, defaultp&gt; size4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of four std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00067">67</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga06862b7d59094244025d34407b2cb796"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef tvec4&lt;std::size_t, defaultp&gt; size4_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector type based of four std::size_t components. </p>
<dl class="section see"><dt>See also</dt><dd>GLM_GTX_std_based_type </dd></dl>
<p>Definition at line <a class="el" href="a00110_source.html#l00083">83</a> of file <a class="el" href="a00110_source.html">std_based_type.hpp</a>.</p>
<p>Transforms a matrix with a translation 4 * 4 matrix created from 3 scalars. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00171.html" title="Defines functions that generate common transformation matrices. ">GLM_GTC_matrix_transform</a> </dd>
<dd>
<a class="el" href="a00233.html" title="Add transformation matrices. ">GLM_GTX_transform</a> </dd></dl>
</div>
</div>