glm/doc/api-0.9.3/a00205.html

205 lines
8.7 KiB
HTML
Raw Normal View History

2011-10-24 14:24:48 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
2011-11-12 23:26:02 +00:00
<!-- Generated by Doxygen 1.7.3 -->
2011-10-24 14:24:48 +00:00
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
2011-11-12 23:26:02 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
2011-10-24 14:24:48 +00:00
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
2011-11-12 23:26:02 +00:00
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
2011-10-24 14:24:48 +00:00
<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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2011-11-12 23:26:02 +00:00
<h1>GLM_GTX_optimum_pow: Optimum pow</h1> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
2011-10-24 14:24:48 +00:00
<div class="contents">
<p>Integer exponentiation of power functions.
2011-11-12 23:26:02 +00:00
<a href="#_details">More...</a></p>
2011-10-24 14:24:48 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00205.html#ga9d9553faa496cfba252747dd84d5db5c">pow2</a> (const genType &amp;x)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00205.html#gae19ea9aab9b6b9bdd01715c512679de1">pow3</a> (const genType &amp;x)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00205.html#gac66dd855fa54fe930c793b94762466a3">pow4</a> (const genType &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec2&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00205.html#ga8d2eac556c39735ab92b6b1b1cfdb664">powOfTwo</a> (const detail::tvec2&lt; int &gt; &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00205.html#ga81f7bd8149b121be346894525d4d143f">powOfTwo</a> (int num)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec3&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00205.html#ga78aa6dc57326eaf40e3d73994940b512">powOfTwo</a> (const detail::tvec3&lt; int &gt; &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">detail::tvec4&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00205.html#ga6a528ec8eb6699cc72b7d3966c8bf166">powOfTwo</a> (const detail::tvec4&lt; int &gt; &amp;x)</td></tr>
2011-10-24 14:24:48 +00:00
</table>
2011-11-12 23:26:02 +00:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2011-10-24 14:24:48 +00:00
<p>Integer exponentiation of power functions. </p>
2011-11-12 23:26:02 +00:00
<p>&lt;<a class="el" href="a00085.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/optimum_pow.hpp</a>&gt; need to be included to use these functionalities. </p>
2011-10-24 14:24:48 +00:00
<hr/><h2>Function Documentation</h2>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga9d9553faa496cfba252747dd84d5db5c"></a><!-- doxytag: member="glm::gtx::pow2" ref="ga9d9553faa496cfba252747dd84d5db5c" args="(const genType &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">genType glm::gtx::pow2 </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns x raised to the power of 2. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="gae19ea9aab9b6b9bdd01715c512679de1"></a><!-- doxytag: member="glm::gtx::pow3" ref="gae19ea9aab9b6b9bdd01715c512679de1" args="(const genType &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">genType glm::gtx::pow3 </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></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>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="gac66dd855fa54fe930c793b94762466a3"></a><!-- doxytag: member="glm::gtx::pow4" ref="gac66dd855fa54fe930c793b94762466a3" args="(const genType &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">genType glm::gtx::pow4 </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const genType &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></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>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga8d2eac556c39735ab92b6b1b1cfdb664"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga8d2eac556c39735ab92b6b1b1cfdb664" args="(const detail::tvec2&lt; int &gt; &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec2&lt;bool&gt; glm::gtx::powOfTwo </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const detail::tvec2&lt; int &gt; &amp;&#160;</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>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga81f7bd8149b121be346894525d4d143f"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga81f7bd8149b121be346894525d4d143f" args="(int num)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">bool glm::gtx::powOfTwo </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if the parameter is a power of 2 number. </p>
<p>From GLM_GTX_optimum_pow extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga78aa6dc57326eaf40e3d73994940b512"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga78aa6dc57326eaf40e3d73994940b512" args="(const detail::tvec3&lt; int &gt; &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;bool&gt; glm::gtx::powOfTwo </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; int &gt; &amp;&#160;</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>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga6a528ec8eb6699cc72b7d3966c8bf166"></a><!-- doxytag: member="glm::gtx::powOfTwo" ref="ga6a528ec8eb6699cc72b7d3966c8bf166" args="(const detail::tvec4&lt; int &gt; &amp;x)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;bool&gt; glm::gtx::powOfTwo </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">const detail::tvec4&lt; int &gt; &amp;&#160;</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>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
2011-11-12 23:26:02 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
2011-10-24 14:24:48 +00:00
</body>
</html>