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

147
doc/api/a00218.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_normalize_dot</title>
<title>0.9.9 API documenation: GLM_GTX_spline</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>
@@ -77,43 +77,65 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_normalize_dot<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_spline<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Dot product of vectors that need to be normalize with a single square root.
<p>Include &lt;<a class="el" href="a00095.html" title="GLM_GTX_spline ">glm/gtx/spline.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:gabf5553d2beb5e536b44abb48525657ec"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gabf5553d2beb5e536b44abb48525657ec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#gabf5553d2beb5e536b44abb48525657ec">fastNormalizeDot</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:gabf5553d2beb5e536b44abb48525657ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalize parameters and returns the dot product of x and y. <a href="a00218.html#gabf5553d2beb5e536b44abb48525657ec">More...</a><br /></td></tr>
<tr class="separator:gabf5553d2beb5e536b44abb48525657ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab445b8fe1f595c1515a8280e6ca89c88"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gab445b8fe1f595c1515a8280e6ca89c88"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#gab445b8fe1f595c1515a8280e6ca89c88">normalizeDot</a> (vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</td></tr>
<tr class="memdesc:gab445b8fe1f595c1515a8280e6ca89c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalize parameters and returns the dot product of x and y. <a href="a00218.html#gab445b8fe1f595c1515a8280e6ca89c88">More...</a><br /></td></tr>
<tr class="separator:gab445b8fe1f595c1515a8280e6ca89c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8119c04f8210fd0d292757565cd6918d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga8119c04f8210fd0d292757565cd6918d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga8119c04f8210fd0d292757565cd6918d">catmullRom</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="memdesc:ga8119c04f8210fd0d292757565cd6918d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a point from a catmull rom curve. <a href="a00218.html#ga8119c04f8210fd0d292757565cd6918d">More...</a><br /></td></tr>
<tr class="separator:ga8119c04f8210fd0d292757565cd6918d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#ga6b867eb52e2fc933d2e0bf26aabc9a70">cubic</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="memdesc:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a point from a cubic curve. <a href="a00218.html#ga6b867eb52e2fc933d2e0bf26aabc9a70">More...</a><br /></td></tr>
<tr class="separator:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00218.html#gaa69e143f6374d32f934a8edeaa50bac9">hermite</a> (genType const &amp;v1, genType const &amp;t1, genType const &amp;v2, genType const &amp;t2, typename genType::value_type const &amp;s)</td></tr>
<tr class="memdesc:gaa69e143f6374d32f934a8edeaa50bac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a point from a hermite curve. <a href="a00218.html#gaa69e143f6374d32f934a8edeaa50bac9">More...</a><br /></td></tr>
<tr class="separator:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Dot product of vectors that need to be normalize with a single square root. </p>
<p>&lt;glm/gtx/normalized_dot.hpp&gt; need to be included to use these functionalities. </p>
<p>Include &lt;<a class="el" href="a00095.html" title="GLM_GTX_spline ">glm/gtx/spline.hpp</a>&gt; to use the features of this extension. </p>
<p>Spline functions </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gabf5553d2beb5e536b44abb48525657ec"></a>
<a class="anchor" id="ga8119c04f8210fd0d292757565cd6918d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::fastNormalizeDot </td>
<td class="memname">GLM_FUNC_DECL genType glm::catmullRom </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -123,27 +145,44 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Normalize parameters and returns the dot product of x and y. </p>
<p>Faster that dot(fastNormalize(x), fastNormalize(y)).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00218.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
<p>Return a point from a catmull rom curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00218.html" title="Include <glm/gtx/spline.hpp> to use the features of this extension. ">GLM_GTX_spline</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="gab445b8fe1f595c1515a8280e6ca89c88"></a>
<a class="anchor" id="ga6b867eb52e2fc933d2e0bf26aabc9a70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::normalizeDot </td>
<td class="memname">GLM_FUNC_DECL genType glm::cubic </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -153,9 +192,55 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Normalize parameters and returns the dot product of x and y. </p>
<p>It's faster that dot(normalize(x), normalize(y)).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00218.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
<p>Return a point from a cubic curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00218.html" title="Include <glm/gtx/spline.hpp> to use the features of this extension. ">GLM_GTX_spline</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa69e143f6374d32f934a8edeaa50bac9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::hermite </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a point from a hermite curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00218.html" title="Include <glm/gtx/spline.hpp> to use the features of this extension. ">GLM_GTX_spline</a> extension. </dd></dl>
</div>
</div>