Updated API doc

This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 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.10"/>
<title>0.9.9 API documenation: rotate_vector.hpp File Reference</title>
<title>0.9.9 API documenation: transform.hpp File Reference</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>
@@ -86,69 +86,41 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">rotate_vector.hpp File Reference</div> </div>
<div class="title">transform.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="a00229.html">GLM_GTX_rotate_vector</a>
<p><a class="el" href="a00221.html">GLM_GTX_transform</a>
<a href="#details">More...</a></p>
<p><a href="a00098_source.html">Go to the source code of this file.</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:ga953ff32250c7a354b299e0ff1dee1fa9"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga953ff32250c7a354b299e0ff1dee1fa9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga953ff32250c7a354b299e0ff1dee1fa9">orientation</a> (vec&lt; 3, T, P &gt; const &amp;Normal, vec&lt; 3, T, P &gt; const &amp;Up)</td></tr>
<tr class="memdesc:ga953ff32250c7a354b299e0ff1dee1fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a rotation matrix from a normal and a up vector. <a href="a00229.html#ga953ff32250c7a354b299e0ff1dee1fa9">More...</a><br /></td></tr>
<tr class="separator:ga953ff32250c7a354b299e0ff1dee1fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac8f7486b0a5a6d09b2142a5f9ec3fbb5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gac8f7486b0a5a6d09b2142a5f9ec3fbb5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#gac8f7486b0a5a6d09b2142a5f9ec3fbb5">rotate</a> (vec&lt; 2, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:gac8f7486b0a5a6d09b2142a5f9ec3fbb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a two dimensional vector. <a href="a00229.html#gac8f7486b0a5a6d09b2142a5f9ec3fbb5">More...</a><br /></td></tr>
<tr class="separator:gac8f7486b0a5a6d09b2142a5f9ec3fbb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f70e3a9e140582af6af61c63b7668f4"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga8f70e3a9e140582af6af61c63b7668f4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga8f70e3a9e140582af6af61c63b7668f4">rotate</a> (vec&lt; 3, T, P &gt; const &amp;v, T const &amp;angle, vec&lt; 3, T, P &gt; const &amp;normal)</td></tr>
<tr class="memdesc:ga8f70e3a9e140582af6af61c63b7668f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a three dimensional vector around an axis. <a href="a00229.html#ga8f70e3a9e140582af6af61c63b7668f4">More...</a><br /></td></tr>
<tr class="separator:ga8f70e3a9e140582af6af61c63b7668f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d6429a5d2075d465d6d9de1a4f9f7c2"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga4d6429a5d2075d465d6d9de1a4f9f7c2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga4d6429a5d2075d465d6d9de1a4f9f7c2">rotate</a> (vec&lt; 4, T, P &gt; const &amp;v, T const &amp;angle, vec&lt; 3, T, P &gt; const &amp;normal)</td></tr>
<tr class="memdesc:ga4d6429a5d2075d465d6d9de1a4f9f7c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a four dimensional vector around an axis. <a href="a00229.html#ga4d6429a5d2075d465d6d9de1a4f9f7c2">More...</a><br /></td></tr>
<tr class="separator:ga4d6429a5d2075d465d6d9de1a4f9f7c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70128127cfd1b119ba469cd8c6545412"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga70128127cfd1b119ba469cd8c6545412"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga70128127cfd1b119ba469cd8c6545412">rotateX</a> (vec&lt; 3, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:ga70128127cfd1b119ba469cd8c6545412"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a three dimensional vector around the X axis. <a href="a00229.html#ga70128127cfd1b119ba469cd8c6545412">More...</a><br /></td></tr>
<tr class="separator:ga70128127cfd1b119ba469cd8c6545412"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a8fe52625aaefdc245287d54ef8f1ba"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga1a8fe52625aaefdc245287d54ef8f1ba"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga1a8fe52625aaefdc245287d54ef8f1ba">rotateX</a> (vec&lt; 4, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:ga1a8fe52625aaefdc245287d54ef8f1ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a four dimensional vector around the X axis. <a href="a00229.html#ga1a8fe52625aaefdc245287d54ef8f1ba">More...</a><br /></td></tr>
<tr class="separator:ga1a8fe52625aaefdc245287d54ef8f1ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54ff886274b556316080413d267516e5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga54ff886274b556316080413d267516e5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga54ff886274b556316080413d267516e5">rotateY</a> (vec&lt; 3, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:ga54ff886274b556316080413d267516e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a three dimensional vector around the Y axis. <a href="a00229.html#ga54ff886274b556316080413d267516e5">More...</a><br /></td></tr>
<tr class="separator:ga54ff886274b556316080413d267516e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4bc1e48be673daba5db569cea397845"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gab4bc1e48be673daba5db569cea397845"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#gab4bc1e48be673daba5db569cea397845">rotateY</a> (vec&lt; 4, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:gab4bc1e48be673daba5db569cea397845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a four dimensional vector around the Y axis. <a href="a00229.html#gab4bc1e48be673daba5db569cea397845">More...</a><br /></td></tr>
<tr class="separator:gab4bc1e48be673daba5db569cea397845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb3b899e1c30ee11455bab4545ce1be0"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gacb3b899e1c30ee11455bab4545ce1be0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#gacb3b899e1c30ee11455bab4545ce1be0">rotateZ</a> (vec&lt; 3, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:gacb3b899e1c30ee11455bab4545ce1be0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a three dimensional vector around the Z axis. <a href="a00229.html#gacb3b899e1c30ee11455bab4545ce1be0">More...</a><br /></td></tr>
<tr class="separator:gacb3b899e1c30ee11455bab4545ce1be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga498000d62e7103378851b1ff5b6c3c14"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga498000d62e7103378851b1ff5b6c3c14"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga498000d62e7103378851b1ff5b6c3c14">rotateZ</a> (vec&lt; 4, T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="memdesc:ga498000d62e7103378851b1ff5b6c3c14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate a four dimensional vector around the Z axis. <a href="a00229.html#ga498000d62e7103378851b1ff5b6c3c14">More...</a><br /></td></tr>
<tr class="separator:ga498000d62e7103378851b1ff5b6c3c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4759411640205da0eb29c6bfe3d4038b"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga4759411640205da0eb29c6bfe3d4038b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00229.html#ga4759411640205da0eb29c6bfe3d4038b">slerp</a> (vec&lt; 3, T, P &gt; const &amp;x, vec&lt; 3, T, P &gt; const &amp;y, T const &amp;a)</td></tr>
<tr class="memdesc:ga4759411640205da0eb29c6bfe3d4038b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns Spherical interpolation between two vectors. <a href="a00229.html#ga4759411640205da0eb29c6bfe3d4038b">More...</a><br /></td></tr>
<tr class="separator:ga4759411640205da0eb29c6bfe3d4038b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf599be4c0e9d99be1f9cddba79b6018b"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaf599be4c0e9d99be1f9cddba79b6018b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#gaf599be4c0e9d99be1f9cddba79b6018b">rotate</a> (T angle, vec&lt; 3, T, Q &gt; const &amp;v)</td></tr>
<tr class="memdesc:gaf599be4c0e9d99be1f9cddba79b6018b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a rotation 4 * 4 matrix created from an axis of 3 scalars and an angle expressed in radians. <a href="a00221.html#gaf599be4c0e9d99be1f9cddba79b6018b">More...</a><br /></td></tr>
<tr class="separator:gaf599be4c0e9d99be1f9cddba79b6018b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafbeefee8fec884d566e4ada0049174d7"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gafbeefee8fec884d566e4ada0049174d7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#gafbeefee8fec884d566e4ada0049174d7">scale</a> (vec&lt; 3, T, Q &gt; const &amp;v)</td></tr>
<tr class="memdesc:gafbeefee8fec884d566e4ada0049174d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. <a href="a00221.html#gafbeefee8fec884d566e4ada0049174d7">More...</a><br /></td></tr>
<tr class="separator:gafbeefee8fec884d566e4ada0049174d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga309a30e652e58c396e2c3d4db3ee7658"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga309a30e652e58c396e2c3d4db3ee7658"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#ga309a30e652e58c396e2c3d4db3ee7658">translate</a> (vec&lt; 3, T, Q &gt; const &amp;v)</td></tr>
<tr class="memdesc:ga309a30e652e58c396e2c3d4db3ee7658"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transforms a matrix with a translation 4 * 4 matrix created from 3 scalars. <a href="a00221.html#ga309a30e652e58c396e2c3d4db3ee7658">More...</a><br /></td></tr>
<tr class="separator:ga309a30e652e58c396e2c3d4db3ee7658"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00229.html">GLM_GTX_rotate_vector</a> </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00158.html" title="The core of GLM, which implements exactly and only the GLSL specification to the degree possible...">GLM Core</a> (dependence) </dd>
<div class="textblock"><p><a class="el" href="a00221.html">GLM_GTX_transform</a> </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00143.html" title="Features that implement in C++ the GLSL specification as closely as possible. ">Core features</a> (dependence) </dd>
<dd>
<a class="el" href="a00234.html" title="Add transformation matrices. ">GLM_GTX_transform</a> (dependence) </dd></dl>
<a class="el" href="a00157.html" title="Include <glm/gtc/matrix_transform.hpp> to use the features of this extension. ">GLM_GTC_matrix_transform</a> (dependence) </dd>
<dd>
<a class="el" href="a00221.html" title="Include <glm/gtx/transform.hpp> to use the features of this extension. ">GLM_GTX_transform</a> </dd>
<dd>
<a class="el" href="a00222.html" title="Include <glm/gtx/transform2.hpp> to use the features of this extension. ">GLM_GTX_transform2</a> </dd></dl>
<p>Definition in file <a class="el" href="a00098_source.html">rotate_vector.hpp</a>.</p>
<p>Definition in file <a class="el" href="a00098_source.html">transform.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>