mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2018-05-08 13:51:58 +02:00
parent 4d4dbcade6
commit c3a41b0ef8
470 changed files with 72126 additions and 68787 deletions
Download Patch File Download Diff File Expand all files Collapse all files

217
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_vector_angle</title>
<title>0.9.9 API documenation: GLM_GTX_std_based_type</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>
@@ -76,124 +76,179 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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_vector_angle<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
<div class="title">GLM_GTX_std_based_type<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<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>Include &lt;<a class="el" href="a00096.html" title="GLM_GTX_std_based_type ">glm/gtx/std_based_type.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>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaeb877ac8f9a3703961736c1c5072cf68"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 1, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#gaeb877ac8f9a3703961736c1c5072cf68">size1</a></td></tr>
<tr class="memdesc:gaeb877ac8f9a3703961736c1c5072cf68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of one std::size_t component. <a href="a00226.html#gaeb877ac8f9a3703961736c1c5072cf68">More...</a><br /></td></tr>
<tr class="separator:gaeb877ac8f9a3703961736c1c5072cf68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf6accc57f5aa50447ba7310ce3f0d6f"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 1, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">size1_t</a></td></tr>
<tr class="memdesc:gaaf6accc57f5aa50447ba7310ce3f0d6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of one std::size_t component. <a href="a00226.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">More...</a><br /></td></tr>
<tr class="separator:gaaf6accc57f5aa50447ba7310ce3f0d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1bfe8c4975ff282bce41be2bacd524fe"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 2, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#ga1bfe8c4975ff282bce41be2bacd524fe">size2</a></td></tr>
<tr class="memdesc:ga1bfe8c4975ff282bce41be2bacd524fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of two std::size_t components. <a href="a00226.html#ga1bfe8c4975ff282bce41be2bacd524fe">More...</a><br /></td></tr>
<tr class="separator:ga1bfe8c4975ff282bce41be2bacd524fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5976c25657d4e2b5f73f39364c3845d6"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 2, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#ga5976c25657d4e2b5f73f39364c3845d6">size2_t</a></td></tr>
<tr class="memdesc:ga5976c25657d4e2b5f73f39364c3845d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of two std::size_t components. <a href="a00226.html#ga5976c25657d4e2b5f73f39364c3845d6">More...</a><br /></td></tr>
<tr class="separator:ga5976c25657d4e2b5f73f39364c3845d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1c72956d0359b0db332c6c8774d3b04"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 3, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#gae1c72956d0359b0db332c6c8774d3b04">size3</a></td></tr>
<tr class="memdesc:gae1c72956d0359b0db332c6c8774d3b04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of three std::size_t components. <a href="a00226.html#gae1c72956d0359b0db332c6c8774d3b04">More...</a><br /></td></tr>
<tr class="separator:gae1c72956d0359b0db332c6c8774d3b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf2654983c60d641fd3808e65a8dfad8d"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 3, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#gaf2654983c60d641fd3808e65a8dfad8d">size3_t</a></td></tr>
<tr class="memdesc:gaf2654983c60d641fd3808e65a8dfad8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of three std::size_t components. <a href="a00226.html#gaf2654983c60d641fd3808e65a8dfad8d">More...</a><br /></td></tr>
<tr class="separator:gaf2654983c60d641fd3808e65a8dfad8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a19dde617beaf8ce3cfc2ac5064e9aa"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 4, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">size4</a></td></tr>
<tr class="memdesc:ga3a19dde617beaf8ce3cfc2ac5064e9aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of four std::size_t components. <a href="a00226.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">More...</a><br /></td></tr>
<tr class="separator:ga3a19dde617beaf8ce3cfc2ac5064e9aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa423efcea63675a2df26990dbcb58656"><td class="memItemLeft" align="right" valign="top">typedef vec&lt; 4, std::size_t, defaultp &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00226.html#gaa423efcea63675a2df26990dbcb58656">size4_t</a></td></tr>
<tr class="memdesc:gaa423efcea63675a2df26990dbcb58656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector type based of four std::size_t components. <a href="a00226.html#gaa423efcea63675a2df26990dbcb58656">More...</a><br /></td></tr>
<tr class="separator:gaa423efcea63675a2df26990dbcb58656"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>
<p>Include &lt;<a class="el" href="a00096.html" title="GLM_GTX_std_based_type ">glm/gtx/std_based_type.hpp</a>&gt; to use the features of this extension. </p>
<p>Adds vector types based on STL value types. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaeb877ac8f9a3703961736c1c5072cf68"></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>
<td class="memname">typedef vec&lt;1, std::size_t, defaultp&gt; size1</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>
<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="a00096_source.html#l00035">35</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga9556a803dce87fe0f42fdabe4ebba1d5"></a>
<a class="anchor" id="gaaf6accc57f5aa50447ba7310ce3f0d6f"></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>
<td class="memname">typedef vec&lt;1, std::size_t, defaultp&gt; size1_t</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>
<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="a00096_source.html#l00051">51</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga706fce3d111f485839756a64f5a48553"></a>
<a class="anchor" id="ga1bfe8c4975ff282bce41be2bacd524fe"></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>
<td class="memname">typedef vec&lt;2, std::size_t, defaultp&gt; size2</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>
<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="a00096_source.html#l00039">39</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga5976c25657d4e2b5f73f39364c3845d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vec&lt;2, 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="a00096_source.html#l00055">55</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gae1c72956d0359b0db332c6c8774d3b04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vec&lt;3, 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="a00096_source.html#l00043">43</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaf2654983c60d641fd3808e65a8dfad8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vec&lt;3, 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="a00096_source.html#l00059">59</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga3a19dde617beaf8ce3cfc2ac5064e9aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vec&lt;4, 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="a00096_source.html#l00047">47</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gaa423efcea63675a2df26990dbcb58656"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vec&lt;4, 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="a00096_source.html#l00063">63</a> of file <a class="el" href="a00096_source.html">std_based_type.hpp</a>.</p>
</div>
</div>