Updated API documentation
This commit is contained in:
Christophe Riccio
@@ -3,7 +3,8 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>Todo List</title>
|
||||
<meta name="generator" content="Doxygen 1.8.5"/>
|
||||
<title>GLM: GLM_GTX_normalize_dot</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>
|
||||
@@ -15,49 +16,112 @@
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">GLM
|
||||
 <span id="projectnumber">0.9.5</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<!-- Generated by Doxygen 1.8.5 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li class="current"><a href="pages.html"><span>Related Pages</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="namespaces.html"><span>Namespaces</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></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">Todo List </div> </div>
|
||||
<div class="title">GLM_GTX_normalize_dot<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><dl class="reflist">
|
||||
<dt><a class="anchor" id="_todo000003"></a>Member <a class="el" href="a00132.html#ga5c4d37c42926b09be4384a9656f73ee4">glm::bitCount</a> (genIUType< T > const &Value)</dt>
|
||||
<dd>Clarify the declaration to specify that scalars are suported. </dd>
|
||||
<dt><a class="anchor" id="_todo000007"></a>Member <a class="el" href="a00145.html#gaf38c4ec0213885e6692f206fe1408c71">glm::epsilon</a> ()</dt>
|
||||
<dd>Implement epsilon for half-precision floating point type. </dd>
|
||||
<dt><a class="anchor" id="_todo000004"></a>Member <a class="el" href="a00132.html#gaf921488d20990ec15f3fde3d1db919f0">glm::findLSB</a> (genIUType< T > const &Value)</dt>
|
||||
<dd>Clarify the declaration to specify that scalars are suported. </dd>
|
||||
<dt><a class="anchor" id="_todo000005"></a>Member <a class="el" href="a00132.html#gaa17f942299cb7a51c60155f9e78228f3">glm::findMSB</a> (genIUType< T > const &Value)</dt>
|
||||
<dd>Clarify the declaration to specify that scalars are suported. </dd>
|
||||
<dt><a class="anchor" id="_todo000001"></a>Member <a class="el" href="a00129.html#ga15f7f0f93ebb026338cb3d7d5876e1b7">glm::intBitsToFloat</a> (genIType const &value)</dt>
|
||||
<dd>Clarify this declaration, we don't need to actually specify the return type </dd>
|
||||
<dt><a class="anchor" id="_todo000006"></a>Member <a class="el" href="a00133.html#ga5d896e8651512fc098a677dbe403eeac">glm::outerProduct</a> (vecType const &c, vecType const &r)</dt>
|
||||
<dd>Clarify the declaration to specify that matType doesn't have to be provided when used. </dd>
|
||||
<dt><a class="anchor" id="_todo000002"></a>Member <a class="el" href="a00129.html#ga3e4a94c90cffac713c287d1fb7b51c08">glm::uintBitsToFloat</a> (genUType const &value)</dt>
|
||||
<dd>Clarify this declaration, we don't need to actually specify the return type </dd>
|
||||
</dl>
|
||||
</div></div><!-- contents -->
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga1b122b5e630204d309e42f16d4823cef"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga1b122b5e630204d309e42f16d4823cef"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00215.html#ga1b122b5e630204d309e42f16d4823cef">fastNormalizeDot</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr class="separator:ga1b122b5e630204d309e42f16d4823cef"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga52c7583d03b57632e26fc88495117c95"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga52c7583d03b57632e26fc88495117c95"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00215.html#ga52c7583d03b57632e26fc88495117c95">normalizeDot</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr class="separator:ga52c7583d03b57632e26fc88495117c95"><td class="memSeparator" colspan="2"> </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><glm/gtx/normalized_dot.hpp> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga1b122b5e630204d309e42f16d4823cef"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::fastNormalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </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>Faster that dot(fastNormalize(x), fastNormalize(y)). From GLM_GTX_normalize_dot extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga52c7583d03b57632e26fc88495117c95"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::normalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </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)). From GLM_GTX_normalize_dot extension. </p>
|
||||
|
||||
</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.8.2
|
||||
</a> 1.8.5
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user