Updated API doc

This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions

View File

@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>0.9.9 API documenation: GLM_GTX_optimum_pow</title>
<title>0.9.9 API documenation: GLM_GTX_string_cast</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>
@@ -77,38 +77,31 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_optimum_pow<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_string_cast<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Integer exponentiation of power functions.
<p>Include &lt;<a class="el" href="a00097.html" title="GLM_GTX_string_cast ">glm/gtx/string_cast.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga19aaff3213bf23bdec3ef124ace237e9">pow2</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:ga19aaff3213bf23bdec3ef124ace237e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 2. <a href="a00220.html#ga19aaff3213bf23bdec3ef124ace237e9">More...</a><br /></td></tr>
<tr class="separator:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga35689d03cd434d6ea819f1942d3bf82e">pow3</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:ga35689d03cd434d6ea819f1942d3bf82e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 3. <a href="a00220.html#ga35689d03cd434d6ea819f1942d3bf82e">More...</a><br /></td></tr>
<tr class="separator:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacef0968763026e180e53e735007dbf5a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gacef0968763026e180e53e735007dbf5a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gacef0968763026e180e53e735007dbf5a">pow4</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:gacef0968763026e180e53e735007dbf5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 4. <a href="a00220.html#gacef0968763026e180e53e735007dbf5a">More...</a><br /></td></tr>
<tr class="separator:gacef0968763026e180e53e735007dbf5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga8f0dced1fd45e67e2d77e80ab93c7af5">to_string</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string from a GLM vector or matrix typed variable. <a href="a00220.html#ga8f0dced1fd45e67e2d77e80ab93c7af5">More...</a><br /></td></tr>
<tr class="separator:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Integer exponentiation of power functions. </p>
<p>&lt;<a class="el" href="a00082.html" title="GLM_GTX_optimum_pow ">glm/gtx/optimum_pow.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Include &lt;<a class="el" href="a00097.html" title="GLM_GTX_string_cast ">glm/gtx/string_cast.hpp</a>&gt; to use the features of this extension. </p>
<p>Setup strings for GLM type values</p>
<p>This extension is not supported with CUDA </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga19aaff3213bf23bdec3ef124ace237e9"></a>
<a class="anchor" id="ga8f0dced1fd45e67e2d77e80ab93c7af5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow2 </td>
<td class="memname">GLM_FUNC_DECL std::string glm::to_string </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
@@ -117,46 +110,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Returns x raised to the power of 2. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00220.html" title="Integer exponentiation of power functions. ">GLM_GTX_optimum_pow</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga35689d03cd434d6ea819f1942d3bf82e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow3 </td>
<td>(</td>
<td class="paramtype">genType const &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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00220.html" title="Integer exponentiation of power functions. ">GLM_GTX_optimum_pow</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gacef0968763026e180e53e735007dbf5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow4 </td>
<td>(</td>
<td class="paramtype">genType const &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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00220.html" title="Integer exponentiation of power functions. ">GLM_GTX_optimum_pow</a> </dd></dl>
<p>Create a string from a GLM vector or matrix typed variable. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00220.html" title="Include <glm/gtx/string_cast.hpp> to use the features of this extension. ">GLM_GTX_string_cast</a> extension. </dd></dl>
</div>
</div>