Updated documentation
This commit is contained in:
@@ -2,80 +2,71 @@
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
|
||||
<title>GLM_GTX_normalize_dot: Normalize dot product</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>GLM_GTX_multiple</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="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</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: Normalize dot product</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
||||
<div class="title">GLM_GTX_multiple</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#ga1b122b5e630204d309e42f16d4823cef">fastNormalizeDot</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#ga52c7583d03b57632e26fc88495117c95">normalizeDot</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr class="memitem:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gaf83b1250f84ae5264a4c7df0a7f70b07">higherMultiple</a> (genType const &Source, genType const &Multiple)</td></tr>
|
||||
<tr class="separator:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gaf3d38b5e3b560ad6245c33a1484c96e2">lowerMultiple</a> (genType const &Source, genType const &Multiple)</td></tr>
|
||||
<tr class="separator:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Dot product of vectors that need to be normalize with a single square root. </p>
|
||||
<p><glm/gtx/normalized_dot.hpp> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="ga1b122b5e630204d309e42f16d4823cef"></a><!-- doxytag: member="glm::fastNormalizeDot" ref="ga1b122b5e630204d309e42f16d4823cef" args="(genType const &x, genType const &y)" -->
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Find the closest number of a number multiple of other number. </p>
|
||||
<p><<a class="el" href="a00062.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/multiple.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gaf83b1250f84ae5264a4c7df0a7f70b07"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::fastNormalizeDot </td>
|
||||
<td class="memname">genType glm::higherMultiple </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
<td class="paramname"><em>Source</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
<td class="paramname"><em>Multiple</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -83,29 +74,28 @@ Functions</h2></td></tr>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</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)). From GLM_GTX_normalize_dot extension. </p>
|
||||
<p>Higher Multiple number of Source. </p>
|
||||
<p>From GLM_GTX_multiple extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga52c7583d03b57632e26fc88495117c95"></a><!-- doxytag: member="glm::normalizeDot" ref="ga52c7583d03b57632e26fc88495117c95" args="(genType const &x, genType const &y)" -->
|
||||
<a class="anchor" id="gaf3d38b5e3b560ad6245c33a1484c96e2"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::normalizeDot </td>
|
||||
<td class="memname">genType glm::lowerMultiple </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
<td class="paramname"><em>Source</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
<td class="paramname"><em>Multiple</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -113,22 +103,19 @@ Functions</h2></td></tr>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</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)). From GLM_GTX_normalize_dot extension. </p>
|
||||
<p>Lower Multiple number of Source. </p>
|
||||
<p>From GLM_GTX_multiple extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user