Updated API documentation

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

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_number_precision</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_component_wise</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,81 +16,136 @@
<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>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_number_precision</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_component_wise<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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gafb6d00d30a02bc379153fbf0859c55fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafb6d00d30a02bc379153fbf0859c55fe"></a>
typedef f16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#gafb6d00d30a02bc379153fbf0859c55fe">f16mat1</a></td></tr>
<tr class="separator:gafb6d00d30a02bc379153fbf0859c55fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga228eca02d3e3f24c2eec052ee7f719fa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga228eca02d3e3f24c2eec052ee7f719fa"></a>
typedef f16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga228eca02d3e3f24c2eec052ee7f719fa">f16mat1x1</a></td></tr>
<tr class="separator:ga228eca02d3e3f24c2eec052ee7f719fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga116e2376ef94e8c60bc5c2b66fc5a6db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga116e2376ef94e8c60bc5c2b66fc5a6db"></a>
typedef f16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga116e2376ef94e8c60bc5c2b66fc5a6db">f16vec1</a></td></tr>
<tr class="separator:ga116e2376ef94e8c60bc5c2b66fc5a6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga145ad477a2a3e152855511c3b52469a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga145ad477a2a3e152855511c3b52469a6"></a>
typedef f32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga145ad477a2a3e152855511c3b52469a6">f32mat1</a></td></tr>
<tr class="separator:ga145ad477a2a3e152855511c3b52469a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac88c6a4dbfc380aa26e3adbbade36348"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac88c6a4dbfc380aa26e3adbbade36348"></a>
typedef f32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#gac88c6a4dbfc380aa26e3adbbade36348">f32mat1x1</a></td></tr>
<tr class="separator:gac88c6a4dbfc380aa26e3adbbade36348"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07f8d7348eb7ae059a84c118fdfeb943"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga07f8d7348eb7ae059a84c118fdfeb943"></a>
typedef f32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga07f8d7348eb7ae059a84c118fdfeb943">f32vec1</a></td></tr>
<tr class="separator:ga07f8d7348eb7ae059a84c118fdfeb943"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59bfa589419b5265d01314fcecd33435"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga59bfa589419b5265d01314fcecd33435"></a>
typedef f64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga59bfa589419b5265d01314fcecd33435">f64mat1</a></td></tr>
<tr class="separator:ga59bfa589419b5265d01314fcecd33435"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga448eeb08d0b7d8c43a8b292c981955fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga448eeb08d0b7d8c43a8b292c981955fd"></a>
typedef f64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga448eeb08d0b7d8c43a8b292c981955fd">f64mat1x1</a></td></tr>
<tr class="separator:ga448eeb08d0b7d8c43a8b292c981955fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae5987a61b8c03d5c432a9e62f0b3efe1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae5987a61b8c03d5c432a9e62f0b3efe1"></a>
typedef f64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#gae5987a61b8c03d5c432a9e62f0b3efe1">f64vec1</a></td></tr>
<tr class="separator:gae5987a61b8c03d5c432a9e62f0b3efe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52cc069a92e126c3a8dcde93424d2ef0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52cc069a92e126c3a8dcde93424d2ef0"></a>
typedef u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga52cc069a92e126c3a8dcde93424d2ef0">u16vec1</a></td></tr>
<tr class="separator:ga52cc069a92e126c3a8dcde93424d2ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bbc1e14aea65cba5e2dcfef6a67d9f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9bbc1e14aea65cba5e2dcfef6a67d9f3"></a>
typedef u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga9bbc1e14aea65cba5e2dcfef6a67d9f3">u32vec1</a></td></tr>
<tr class="separator:ga9bbc1e14aea65cba5e2dcfef6a67d9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga818de170e2584ab037130f2881925974"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga818de170e2584ab037130f2881925974"></a>
typedef u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga818de170e2584ab037130f2881925974">u64vec1</a></td></tr>
<tr class="separator:ga818de170e2584ab037130f2881925974"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5853fe457f4c8a6bc09343d0e9833980"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5853fe457f4c8a6bc09343d0e9833980"></a>
typedef u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00191.html#ga5853fe457f4c8a6bc09343d0e9833980">u8vec1</a></td></tr>
<tr class="separator:ga5853fe457f4c8a6bc09343d0e9833980"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga70016a744618371aafdb9a6ed8b9ffda">compAdd</a> (genType const &amp;v)</td></tr>
<tr class="separator:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7570faad7d86649a9a5d766f3e731e89"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga7570faad7d86649a9a5d766f3e731e89"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga7570faad7d86649a9a5d766f3e731e89">compMax</a> (genType const &amp;v)</td></tr>
<tr class="separator:ga7570faad7d86649a9a5d766f3e731e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe82f26e0f548e09008ad0874af9e837"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gabe82f26e0f548e09008ad0874af9e837"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gabe82f26e0f548e09008ad0874af9e837">compMin</a> (genType const &amp;v)</td></tr>
<tr class="separator:gabe82f26e0f548e09008ad0874af9e837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gac0831fc64d0ce245f7f961d72e1893fd">compMul</a> (genType const &amp;v)</td></tr>
<tr class="separator:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Defined size types. </p>
<p>&lt;<a class="el" href="a00068.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/number_precision.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Operations between components of a type. </p>
<p>&lt;<a class="el" href="a00018.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/component_wise.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga70016a744618371aafdb9a6ed8b9ffda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::compAdd </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add all vector components together. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00191.html" title="Operations between components of a type. ">GLM_GTX_component_wise</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7570faad7d86649a9a5d766f3e731e89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::compMax </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the maximum value between single vector components. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00191.html" title="Operations between components of a type. ">GLM_GTX_component_wise</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gabe82f26e0f548e09008ad0874af9e837"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::compMin </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the minimum value between single vector components. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00191.html" title="Operations between components of a type. ">GLM_GTX_component_wise</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac0831fc64d0ce245f7f961d72e1893fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::compMul </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiply all vector components together. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00191.html" title="Operations between components of a type. ">GLM_GTX_component_wise</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<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>