Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTX_integer: Extended integer functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<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-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -33,12 +47,9 @@
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTX_integer: Extended integer functions</h1> </div>
<div class="title">GLM_GTX_integer: Extended integer functions</div> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Add support for integer for core functions.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
@@ -46,19 +57,19 @@ Typedefs</h2></td></tr>
<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>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00189.html#ga56d0b5195667769d9f43859d3fd0ed12">factorial</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00189.html#ga6912d62d2f314fa38ef4c94fda778294">factorial</a> (genType const &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga054b9fd24e0d18af9ae7e9b6bfb5a2c9">floor_log2</a> (unsigned int x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00189.html#ga48b54b38896ef5bd1fdf2e60f1e2009f">log2</a> (genIUType const &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga5f05facb4b70489113d284edd53babcb">mod</a> (uint x, uint y)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00189.html#gae6836e4b1445f55ab30f32e3da36c284">log2</a> (genIUType const &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga01082d953f4864e9accbcb84987a1066">mod</a> (int x, int y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga5f05facb4b70489113d284edd53babcb">mod</a> (uint x, uint y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#gade78ad3e82d61001f4641571db4dd56e">nlz</a> (uint x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#gaaff5d34714236dbeddd49e4ecb045abc">pow</a> (uint x, uint y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga0073d991d1c9c9a37b458eb512535fc8">pow</a> (int x, int y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#gaaff5d34714236dbeddd49e4ecb045abc">pow</a> (uint x, uint y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#ga6aad88cb883810890ac2b68000c544c1">sqrt</a> (int x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00189.html#gafb4f8acb2b577775e2ef1a86e7312340">sqrt</a> (uint x)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Add support for integer for core functions. </p>
<p>&lt;<a class="el" href="a00057.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Typedef Documentation</h2>
@@ -81,7 +92,7 @@ Functions</h2></td></tr>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga56d0b5195667769d9f43859d3fd0ed12"></a><!-- doxytag: member="glm::factorial" ref="ga56d0b5195667769d9f43859d3fd0ed12" args="(genType const &amp;x)" -->
<a class="anchor" id="ga6912d62d2f314fa38ef4c94fda778294"></a><!-- doxytag: member="glm::factorial" ref="ga6912d62d2f314fa38ef4c94fda778294" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -120,7 +131,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga48b54b38896ef5bd1fdf2e60f1e2009f"></a><!-- doxytag: member="glm::log2" ref="ga48b54b38896ef5bd1fdf2e60f1e2009f" args="(genIUType const &amp;x)" -->
<a class="anchor" id="gae6836e4b1445f55ab30f32e3da36c284"></a><!-- doxytag: member="glm::log2" ref="gae6836e4b1445f55ab30f32e3da36c284" args="(genIUType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -140,20 +151,20 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga5f05facb4b70489113d284edd53babcb"></a><!-- doxytag: member="glm::mod" ref="ga5f05facb4b70489113d284edd53babcb" args="(uint x, uint y)" -->
<a class="anchor" id="ga01082d953f4864e9accbcb84987a1066"></a><!-- doxytag: member="glm::mod" ref="ga01082d953f4864e9accbcb84987a1066" args="(int x, int y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint glm::mod </td>
<td class="memname">int glm::mod </td>
<td>(</td>
<td class="paramtype">uint&#160;</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint&#160;</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -170,20 +181,20 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga01082d953f4864e9accbcb84987a1066"></a><!-- doxytag: member="glm::mod" ref="ga01082d953f4864e9accbcb84987a1066" args="(int x, int y)" -->
<a class="anchor" id="ga5f05facb4b70489113d284edd53babcb"></a><!-- doxytag: member="glm::mod" ref="ga5f05facb4b70489113d284edd53babcb" args="(uint x, uint y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int glm::mod </td>
<td class="memname">uint glm::mod </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramtype">uint&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramtype">uint&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -220,20 +231,20 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaaff5d34714236dbeddd49e4ecb045abc"></a><!-- doxytag: member="glm::pow" ref="gaaff5d34714236dbeddd49e4ecb045abc" args="(uint x, uint y)" -->
<a class="anchor" id="ga0073d991d1c9c9a37b458eb512535fc8"></a><!-- doxytag: member="glm::pow" ref="ga0073d991d1c9c9a37b458eb512535fc8" args="(int x, int y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint glm::pow </td>
<td class="memname">int glm::pow </td>
<td>(</td>
<td class="paramtype">uint&#160;</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint&#160;</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -250,20 +261,20 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga0073d991d1c9c9a37b458eb512535fc8"></a><!-- doxytag: member="glm::pow" ref="ga0073d991d1c9c9a37b458eb512535fc8" args="(int x, int y)" -->
<a class="anchor" id="gaaff5d34714236dbeddd49e4ecb045abc"></a><!-- doxytag: member="glm::pow" ref="gaaff5d34714236dbeddd49e4ecb045abc" args="(uint x, uint y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int glm::pow </td>
<td class="memname">uint glm::pow </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramtype">uint&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramtype">uint&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -321,8 +332,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<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.7.3 </small></address>
<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.7.5
</small></address>
</body>
</html>