Updated documentation
This commit is contained in:
Christophe Riccio
@@ -2,219 +2,120 @@
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
|
||||
<title>GLM_GTX_optimum_pow: Optimum pow</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>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>
|
||||
<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_optimum_pow: Optimum pow</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
||||
<div class="title">GLM_GTX_normalize_dot</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 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#ga56697e47a1375a352a746a5be3480fc8">pow2</a> (const genType &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#gad538f8d993d8dd645c7b0c8b1cc79b09">pow3</a> (const genType &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#ga95573ae0578e980759bd329d96b13c25">pow4</a> (const genType &x)</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#ga81f7bd8149b121be346894525d4d143f">powOfTwo</a> (int num)</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec2< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#ga8d2eac556c39735ab92b6b1b1cfdb664">powOfTwo</a> (const detail::tvec2< int > &x)</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec3< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#ga78aa6dc57326eaf40e3d73994940b512">powOfTwo</a> (const detail::tvec3< int > &x)</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec4< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#ga6a528ec8eb6699cc72b7d3966c8bf166">powOfTwo</a> (const detail::tvec4< int > &x)</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="a00190.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="a00190.html#ga52c7583d03b57632e26fc88495117c95">normalizeDot</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr class="separator:ga52c7583d03b57632e26fc88495117c95"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Integer exponentiation of power functions. </p>
|
||||
<p><<a class="el" href="a00070.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/optimum_pow.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="ga56697e47a1375a352a746a5be3480fc8"></a><!-- doxytag: member="glm::gtx::pow2" ref="ga56697e47a1375a352a746a5be3480fc8" args="(const genType &x)" -->
|
||||
<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 glm::gtx::pow2 </td>
|
||||
<td class="memname">genType::value_type glm::fastNormalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const genType & </td>
|
||||
<td class="paramname"><em>x</em></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">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns x raised to the power of 2. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
<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="gad538f8d993d8dd645c7b0c8b1cc79b09"></a><!-- doxytag: member="glm::gtx::pow3" ref="gad538f8d993d8dd645c7b0c8b1cc79b09" args="(const genType &x)" -->
|
||||
<a class="anchor" id="ga52c7583d03b57632e26fc88495117c95"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType glm::gtx::pow3 </td>
|
||||
<td class="memname">genType::value_type glm::normalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const genType & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Returns x raised to the power of 3. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga95573ae0578e980759bd329d96b13c25"></a><!-- doxytag: member="glm::gtx::pow4" ref="ga95573ae0578e980759bd329d96b13c25" args="(const genType &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType glm::gtx::pow4 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const genType & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Returns x raised to the power of 4. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga81f7bd8149b121be346894525d4d143f"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga81f7bd8149b121be346894525d4d143f" args="(int num)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool glm::gtx::powOfTwo </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>num</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks if the parameter is a power of 2 number. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
<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>
|
||||
<a class="anchor" id="ga8d2eac556c39735ab92b6b1b1cfdb664"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga8d2eac556c39735ab92b6b1b1cfdb664" args="(const detail::tvec2< int > &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec2<bool> glm::gtx::powOfTwo </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const detail::tvec2< int > & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga78aa6dc57326eaf40e3d73994940b512"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga78aa6dc57326eaf40e3d73994940b512" args="(const detail::tvec3< int > &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec3<bool> glm::gtx::powOfTwo </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const detail::tvec3< int > & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
|
||||
<p>From GLM_GTX_optimum_pow extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga6a528ec8eb6699cc72b7d3966c8bf166"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga6a528ec8eb6699cc72b7d3966c8bf166" args="(const detail::tvec4< int > &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">detail::tvec4<bool> glm::gtx::powOfTwo </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const detail::tvec4< int > & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Checks to determine if the parameter component are power of 2 numbers. </p>
|
||||
<p>From GLM_GTX_optimum_pow 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