mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
doc/api/a00212.html
View File

@@ -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>GLM_GTX_verbose_operator</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: 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>
@@ -15,18 +16,23 @@
<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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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>
@@ -35,47 +41,38 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_verbose_operator</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_multiple<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="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:ga5d32b6e43b41e5f630d2dc41c4e36094"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:ga5d32b6e43b41e5f630d2dc41c4e36094"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#ga5d32b6e43b41e5f630d2dc41c4e36094">add</a> (genTypeT const &amp;a, genTypeU const &amp;b)</td></tr>
<tr class="separator:ga5d32b6e43b41e5f630d2dc41c4e36094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae39cb52e643ec143a30b641d062a50b9"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:gae39cb52e643ec143a30b641d062a50b9"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#gae39cb52e643ec143a30b641d062a50b9">div</a> (genTypeT const &amp;a, genTypeU const &amp;b)</td></tr>
<tr class="separator:gae39cb52e643ec143a30b641d062a50b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga757b5f103400c11aa4da962d9edb40eb"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU , typename genTypeV &gt; </td></tr>
<tr class="memitem:ga757b5f103400c11aa4da962d9edb40eb"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#ga757b5f103400c11aa4da962d9edb40eb">mad</a> (genTypeT const &amp;a, genTypeU const &amp;b, genTypeV const &amp;c)</td></tr>
<tr class="separator:ga757b5f103400c11aa4da962d9edb40eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffbfa2a8416cf5677e677bcfc393933a"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:gaffbfa2a8416cf5677e677bcfc393933a"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#gaffbfa2a8416cf5677e677bcfc393933a">mul</a> (genTypeT const &amp;a, genTypeU const &amp;b)</td></tr>
<tr class="separator:gaffbfa2a8416cf5677e677bcfc393933a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ace56e6e27f92d73027da7e1025d27e"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:ga9ace56e6e27f92d73027da7e1025d27e"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#ga9ace56e6e27f92d73027da7e1025d27e">sub</a> (genTypeT const &amp;a, genTypeU const &amp;b)</td></tr>
<tr class="separator:ga9ace56e6e27f92d73027da7e1025d27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#gaf83b1250f84ae5264a4c7df0a7f70b07">higherMultiple</a> (genType const &amp;Source, genType const &amp;Multiple)</td></tr>
<tr class="separator:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00212.html#gaf3d38b5e3b560ad6245c33a1484c96e2">lowerMultiple</a> (genType const &amp;Source, genType const &amp;Multiple)</td></tr>
<tr class="separator:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use words to replace operators. </p>
<p>&lt;<a class="el" href="a00123.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/verbose_operator.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Find the closest number of a number multiple of other number. </p>
<p>&lt;<a class="el" href="a00082.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/multiple.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga5d32b6e43b41e5f630d2dc41c4e36094"></a>
<a class="anchor" id="gaf83b1250f84ae5264a4c7df0a7f70b07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::add </td>
<td class="memname">genType glm::higherMultiple </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -85,25 +82,39 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Addition of two values From GLM_GTX_verbose_operator extension. </p>
<p>Higher multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Source</td><td></td></tr>
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00212.html" title="Find the closest number of a number multiple of other number. ">GLM_GTX_multiple</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae39cb52e643ec143a30b641d062a50b9"></a>
<a class="anchor" id="gaf3d38b5e3b560ad6245c33a1484c96e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::div </td>
<td class="memname">genType glm::lowerMultiple </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -113,97 +124,21 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Division of two values From GLM_GTX_verbose_operator extension. </p>
</div>
</div>
<a class="anchor" id="ga757b5f103400c11aa4da962d9edb40eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::mad </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeV const &amp;&#160;</td>
<td class="paramname"><em>c</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiplication and addition of three values From GLM_GTX_verbose_operator extension. </p>
</div>
</div>
<a class="anchor" id="gaffbfa2a8416cf5677e677bcfc393933a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::mul </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiplication of two values From GLM_GTX_verbose_operator extension. </p>
</div>
</div>
<a class="anchor" id="ga9ace56e6e27f92d73027da7e1025d27e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::sub </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Substration of two values From GLM_GTX_verbose_operator extension. </p>
<p>Lower multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Source</td><td></td></tr>
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00212.html" title="Find the closest number of a number multiple of other number. ">GLM_GTX_multiple</a> </dd></dl>
</div>
</div>
@@ -212,7 +147,7 @@ Functions</h2></td></tr>
<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.8.2
</a> 1.8.5
</small></address>
</body>
</html>