mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

123
doc/api/a00226.html
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: GLM_GTX_range</title>
<title>0.9.9 API documenation: GLM_GTX_vector_angle</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>
@@ -74,17 +74,128 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_range<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_vector_angle<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines begin and end for vectors and matrices.
<p>Include &lt;<a class="el" href="a00131.html" title="GLM_GTX_vector_angle ">glm/gtx/vector_angle.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</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:ga2e2917b4cb75ca3d043ac15ff88f14e1"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga2e2917b4cb75ca3d043ac15ff88f14e1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00226.html#ga2e2917b4cb75ca3d043ac15ff88f14e1">angle</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga2e2917b4cb75ca3d043ac15ff88f14e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the absolute angle between two vectors. <a href="a00226.html#ga2e2917b4cb75ca3d043ac15ff88f14e1">More...</a><br /></td></tr>
<tr class="separator:ga2e2917b4cb75ca3d043ac15ff88f14e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9556a803dce87fe0f42fdabe4ebba1d5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga9556a803dce87fe0f42fdabe4ebba1d5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00226.html#ga9556a803dce87fe0f42fdabe4ebba1d5">orientedAngle</a> (vec&lt; 2, T, Q &gt; const &amp;x, vec&lt; 2, T, Q &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga9556a803dce87fe0f42fdabe4ebba1d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the oriented angle between two 2d vectors. <a href="a00226.html#ga9556a803dce87fe0f42fdabe4ebba1d5">More...</a><br /></td></tr>
<tr class="separator:ga9556a803dce87fe0f42fdabe4ebba1d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga706fce3d111f485839756a64f5a48553"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga706fce3d111f485839756a64f5a48553"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00226.html#ga706fce3d111f485839756a64f5a48553">orientedAngle</a> (vec&lt; 3, T, Q &gt; const &amp;x, vec&lt; 3, T, Q &gt; const &amp;y, vec&lt; 3, T, Q &gt; const &amp;ref)</td></tr>
<tr class="memdesc:ga706fce3d111f485839756a64f5a48553"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the oriented angle between two 3d vectors based from a reference axis. <a href="a00226.html#ga706fce3d111f485839756a64f5a48553">More...</a><br /></td></tr>
<tr class="separator:ga706fce3d111f485839756a64f5a48553"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Defines begin and end for vectors and matrices. </p>
<p>Useful for range-based for loop. The range is defined over the elements, not over columns or rows (e.g. mat4 has 16 elements).</p>
<p>&lt;<a class="el" href="a00094.html" title="GLM_GTX_range ">glm/gtx/range.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Include &lt;<a class="el" href="a00131.html" title="GLM_GTX_vector_angle ">glm/gtx/vector_angle.hpp</a>&gt; to use the features of this extension. </p>
<p>Compute angle between vectors </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga2e2917b4cb75ca3d043ac15ff88f14e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::angle </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the absolute angle between two vectors. </p>
<p>Parameters need to be normalized. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00226.html" title="Include <glm/gtx/vector_angle.hpp> to use the features of this extension. ">GLM_GTX_vector_angle</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="ga9556a803dce87fe0f42fdabe4ebba1d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::orientedAngle </td>
<td>(</td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the oriented angle between two 2d vectors. </p>
<p>Parameters need to be normalized. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00226.html" title="Include <glm/gtx/vector_angle.hpp> to use the features of this extension. ">GLM_GTX_vector_angle</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="ga706fce3d111f485839756a64f5a48553"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::orientedAngle </td>
<td>(</td>
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>ref</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the oriented angle between two 3d vectors based from a reference axis. </p>
<p>Parameters need to be normalized. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00226.html" title="Include <glm/gtx/vector_angle.hpp> to use the features of this extension. ">GLM_GTX_vector_angle</a> extension. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>