Updated API doc

This commit is contained in:
Christophe Riccio
2018-09-02 23:34:18 +02:00
parent 49b508a1ab
commit 0c2e470baf
1013 changed files with 94654 additions and 80816 deletions

View File

@@ -3,17 +3,15 @@
<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.10"/>
<title>0.9.9 API documenation: GLM_GTX_normalize_dot</title>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>0.9.9 API documenation: quaternion_exponential.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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -32,34 +30,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -74,98 +60,46 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_02cc19cee4c4780485bfe81520450212.html">christophericcio</a></li><li class="navelem"><a class="el" href="dir_54de7df3bc9880881b14ec07f256fd2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_6399a054f5929b58eaa476233e406ce8.html">Repository</a></li><li class="navelem"><a class="el" href="dir_627f4a52155b61a75c7c4851d7df9027.html">Github</a></li><li class="navelem"><a class="el" href="dir_ffdfd01cf51cdb2fe8bd5e55c6e0c4e8.html">glm</a></li><li class="navelem"><a class="el" href="dir_4ca6aa55b50e6be994025af27820140e.html">glm</a></li><li class="navelem"><a class="el" href="dir_b115b02f1dab989141fcd87ab0462f01.html">ext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<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="a00154.html">Experimental extensions</a></div></div> </div>
<div class="title">quaternion_exponential.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Include &lt;glm/gtx/normalized_dot.hpp&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<p><a href="a00212_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:ga2746fb9b5bd22b06b2f7c8babba5de9e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga2746fb9b5bd22b06b2f7c8babba5de9e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#ga2746fb9b5bd22b06b2f7c8babba5de9e">fastNormalizeDot</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
<tr class="memdesc:ga2746fb9b5bd22b06b2f7c8babba5de9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalize parameters and returns the dot product of x and y. <a href="a00212.html#ga2746fb9b5bd22b06b2f7c8babba5de9e">More...</a><br /></td></tr>
<tr class="separator:ga2746fb9b5bd22b06b2f7c8babba5de9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb140a2b903115d318c8b0a2fb5a5daa"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gacb140a2b903115d318c8b0a2fb5a5daa"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#gacb140a2b903115d318c8b0a2fb5a5daa">normalizeDot</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
<tr class="memdesc:gacb140a2b903115d318c8b0a2fb5a5daa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalize parameters and returns the dot product of x and y. <a href="a00212.html#gacb140a2b903115d318c8b0a2fb5a5daa">More...</a><br /></td></tr>
<tr class="separator:gacb140a2b903115d318c8b0a2fb5a5daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00677.html#gaab2d37ef7265819f1d2939b9dc2c52ac">exp</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
<tr class="separator:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00677.html#gaa5f7b20e296671b16ce25a2ab7ad5473">log</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
<tr class="separator:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00677.html#ga4975ffcacd312a8c0bbd046a76c5607e">pow</a> (qua&lt; T, Q &gt; const &amp;q, T y)</td></tr>
<tr class="separator:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00677.html#ga64b7b255ed7bcba616fe6b44470b022e">sqrt</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
<tr class="separator:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;glm/gtx/normalized_dot.hpp&gt; to use the features of this extension. </p>
<p>Dot product of vectors that need to be normalize with a single square root. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga2746fb9b5bd22b06b2f7c8babba5de9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::fastNormalizeDot </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">
<div class="textblock"><p><a class="el" href="a00672.html">GLM_EXT_quaternion_exponential</a> </p>
<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="a00212.html" title="Include <glm/gtx/normalized_dot.hpp> to use the features of this extension. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="gacb140a2b903115d318c8b0a2fb5a5daa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::normalizeDot </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>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="a00212.html" title="Include <glm/gtx/normalized_dot.hpp> to use the features of this extension. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
</div>
</div>
</div><!-- contents -->
<p class="definition">Definition in file <a class="el" href="a00212_source.html">quaternion_exponential.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<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.10
</a> 1.8.14
</small></address>
</body>
</html>