Updated API documentation

This commit is contained in:
Christophe Riccio
2018-05-08 13:51:58 +02:00
parent 4d4dbcade6
commit c3a41b0ef8
470 changed files with 72126 additions and 68787 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_wrap</title>
<title>0.9.9 API documenation: GLM_GTX_texture</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>
@@ -78,109 +78,53 @@ 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_wrap<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
<div class="title">GLM_GTX_texture<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Include &lt;<a class="el" href="a00134.html" title="GLM_GTX_wrap ">glm/gtx/wrap.hpp</a>&gt; to use the features of this extension.
<p>Include &lt;<a class="el" href="a00098.html" title="GLM_GTX_texture ">glm/gtx/texture.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:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga6c0cc6bd1d67ea1008d2592e998bad33">clamp</a> (genType const &amp;Texcoord)</td></tr>
<tr class="memdesc:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate GL_CLAMP OpenGL wrap mode. <a href="a00228.html#ga6c0cc6bd1d67ea1008d2592e998bad33">More...</a><br /></td></tr>
<tr class="separator:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa6856a0a048d2749252848da35e10c8b"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa6856a0a048d2749252848da35e10c8b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#gaa6856a0a048d2749252848da35e10c8b">mirrorClamp</a> (genType const &amp;Texcoord)</td></tr>
<tr class="memdesc:gaa6856a0a048d2749252848da35e10c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate GL_MIRRORED_REPEAT OpenGL wrap mode. <a href="a00228.html#gaa6856a0a048d2749252848da35e10c8b">More...</a><br /></td></tr>
<tr class="separator:gaa6856a0a048d2749252848da35e10c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga16a89b0661b60d5bea85137bbae74d73">mirrorRepeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="memdesc:ga16a89b0661b60d5bea85137bbae74d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate GL_MIRROR_REPEAT OpenGL wrap mode. <a href="a00228.html#ga16a89b0661b60d5bea85137bbae74d73">More...</a><br /></td></tr>
<tr class="separator:ga16a89b0661b60d5bea85137bbae74d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga809650c6310ea7c42666e918c117fb6f">repeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="memdesc:ga809650c6310ea7c42666e918c117fb6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate GL_REPEAT OpenGL wrap mode. <a href="a00228.html#ga809650c6310ea7c42666e918c117fb6f">More...</a><br /></td></tr>
<tr class="separator:ga809650c6310ea7c42666e918c117fb6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa8c377f4e63486db4fa872d77880da73"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaa8c377f4e63486db4fa872d77880da73"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#gaa8c377f4e63486db4fa872d77880da73">levels</a> (vec&lt; L, T, Q &gt; const &amp;Extent)</td></tr>
<tr class="memdesc:gaa8c377f4e63486db4fa872d77880da73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the number of mipmaps levels necessary to create a mipmap complete texture. <a href="a00228.html#gaa8c377f4e63486db4fa872d77880da73">More...</a><br /></td></tr>
<tr class="separator:gaa8c377f4e63486db4fa872d77880da73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;<a class="el" href="a00134.html" title="GLM_GTX_wrap ">glm/gtx/wrap.hpp</a>&gt; to use the features of this extension. </p>
<p>Include &lt;<a class="el" href="a00098.html" title="GLM_GTX_texture ">glm/gtx/texture.hpp</a>&gt; to use the features of this extension. </p>
<p>Wrapping mode of texture coordinates. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6c0cc6bd1d67ea1008d2592e998bad33"></a>
<a class="anchor" id="gaa8c377f4e63486db4fa872d77880da73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::clamp </td>
<td class="memname">T glm::levels </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Extent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_CLAMP OpenGL wrap mode. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa6856a0a048d2749252848da35e10c8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::mirrorClamp </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_MIRRORED_REPEAT OpenGL wrap mode. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="ga16a89b0661b60d5bea85137bbae74d73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::mirrorRepeat </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_MIRROR_REPEAT OpenGL wrap mode. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
</div>
</div>
<a class="anchor" id="ga809650c6310ea7c42666e918c117fb6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::repeat </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_REPEAT OpenGL wrap mode. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
<p>Compute the number of mipmaps levels necessary to create a mipmap complete texture. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Extent</td><td>Extent of the texture base level mipmap </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
</table>
</dd>
</dl>
</div>
</div>