mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen for 0.9.6 API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions
Download Patch File Download Diff File Expand all files Collapse all files

346
doc/api/a00225.html
View File

@@ -3,8 +3,8 @@
<head>
<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.5"/>
<title>GLM: GLM_GTX_rotate_vector</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: GLM_GTX_raw_data</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>
@@ -16,9 +16,9 @@
<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 id="projectname">0.9.6
</div>
</td>
</tr>
@@ -26,361 +26,103 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<!-- Generated by Doxygen 1.8.8 -->
<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="#func-members">Functions</a> </div>
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_rotate_vector<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_raw_data<div class="ingroups"><a class="el" href="a00160.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga69a9261c66a81fd52afe8199b30be239"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga69a9261c66a81fd52afe8199b30be239"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga69a9261c66a81fd52afe8199b30be239">orientation</a> (detail::tvec3&lt; T, P &gt; const &amp;Normal, detail::tvec3&lt; T, P &gt; const &amp;Up)</td></tr>
<tr class="separator:ga69a9261c66a81fd52afe8199b30be239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd92a2c227268831c0c47b4a5ac9c02a"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gabd92a2c227268831c0c47b4a5ac9c02a"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#gabd92a2c227268831c0c47b4a5ac9c02a">rotate</a> (detail::tvec2&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:gabd92a2c227268831c0c47b4a5ac9c02a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25898aa99e4930f99cc26f49f7dc8b21"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga25898aa99e4930f99cc26f49f7dc8b21"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga25898aa99e4930f99cc26f49f7dc8b21">rotate</a> (detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:ga25898aa99e4930f99cc26f49f7dc8b21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f68b174013541f794d81056a1a0a94e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga7f68b174013541f794d81056a1a0a94e"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga7f68b174013541f794d81056a1a0a94e">rotate</a> (detail::tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:ga7f68b174013541f794d81056a1a0a94e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3c274e51d6546dcbca6759b2b78c8d7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gac3c274e51d6546dcbca6759b2b78c8d7"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#gac3c274e51d6546dcbca6759b2b78c8d7">rotateX</a> (detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:gac3c274e51d6546dcbca6759b2b78c8d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cff0978db181920b458c42f07e35ff6"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga3cff0978db181920b458c42f07e35ff6"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga3cff0978db181920b458c42f07e35ff6">rotateX</a> (detail::tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga3cff0978db181920b458c42f07e35ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4cec4c2bd2d787429a32f77fe32dd31e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga4cec4c2bd2d787429a32f77fe32dd31e"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga4cec4c2bd2d787429a32f77fe32dd31e">rotateY</a> (detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga4cec4c2bd2d787429a32f77fe32dd31e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga595bf385a10fdd1b9c88030ac728a850"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga595bf385a10fdd1b9c88030ac728a850"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga595bf385a10fdd1b9c88030ac728a850">rotateY</a> (detail::tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga595bf385a10fdd1b9c88030ac728a850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57908a3933a843921628d683049534e3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga57908a3933a843921628d683049534e3"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga57908a3933a843921628d683049534e3">rotateZ</a> (detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga57908a3933a843921628d683049534e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43654feeb2ef123ed28898da89ae60e2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga43654feeb2ef123ed28898da89ae60e2"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00225.html#ga43654feeb2ef123ed28898da89ae60e2">rotateZ</a> (detail::tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga43654feeb2ef123ed28898da89ae60e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga3005cb0d839d546c616becfa6602c607"><td class="memItemLeft" align="right" valign="top">typedef detail::uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00225.html#ga3005cb0d839d546c616becfa6602c607">byte</a></td></tr>
<tr class="separator:ga3005cb0d839d546c616becfa6602c607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="memItemLeft" align="right" valign="top">typedef detail::uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00225.html#ga86e46fff9f80ae33893d8d697f2ca98a">dword</a></td></tr>
<tr class="separator:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4021754ffb8e5ef14c75802b15657714"><td class="memItemLeft" align="right" valign="top">typedef detail::uint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00225.html#ga4021754ffb8e5ef14c75802b15657714">qword</a></td></tr>
<tr class="separator:ga4021754ffb8e5ef14c75802b15657714"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="memItemLeft" align="right" valign="top">typedef detail::uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00225.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">word</a></td></tr>
<tr class="separator:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Function to directly rotate a vector. </p>
<p>&lt;<a class="el" href="a00106.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/rotate_vector.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga69a9261c66a81fd52afe8199b30be239"></a>
<p>Projection of a vector to other one. </p>
<p>&lt;<a class="el" href="a00098.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="ga3005cb0d839d546c616becfa6602c607"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T, P&gt; glm::orientation </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>Up</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="memname">typedef detail::uint8 byte</td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a rotation matrix from a normal and a up vector. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Type for byte numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00098_source.html#l00055">55</a> of file <a class="el" href="a00098_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gabd92a2c227268831c0c47b4a5ac9c02a"></a>
<a class="anchor" id="ga86e46fff9f80ae33893d8d697f2ca98a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec2&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="memname">typedef detail::uint32 dword</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a two dimensional vector. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Type for dword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00098_source.html#l00063">63</a> of file <a class="el" href="a00098_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga25898aa99e4930f99cc26f49f7dc8b21"></a>
<a class="anchor" id="ga4021754ffb8e5ef14c75802b15657714"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="memname">typedef detail::uint64 qword</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Type for qword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00098_source.html#l00067">67</a> of file <a class="el" href="a00098_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga7f68b174013541f794d81056a1a0a94e"></a>
<a class="anchor" id="ga16e9fea0ef1e6c4ef472d3d1731c49a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="memname">typedef detail::uint16 word</td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Type for word numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
</div>
</div>
<a class="anchor" id="gac3c274e51d6546dcbca6759b2b78c8d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T, P&gt; glm::rotateX </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga3cff0978db181920b458c42f07e35ff6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T, P&gt; glm::rotateX </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimentionnals vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga4cec4c2bd2d787429a32f77fe32dd31e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T, P&gt; glm::rotateY </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the Y axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga595bf385a10fdd1b9c88030ac728a850"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T, P&gt; glm::rotateY </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga57908a3933a843921628d683049534e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T, P&gt; glm::rotateZ </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the Z axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga43654feeb2ef123ed28898da89ae60e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T, P&gt; glm::rotateZ </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Definition at line <a class="el" href="a00098_source.html#l00059">59</a> of file <a class="el" href="a00098_source.html">raw_data.hpp</a>.</p>
</div>
</div>
@@ -389,7 +131,7 @@ Functions</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.5
</a> 1.8.8
</small></address>
</body>
</html>