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

291
doc/api/a00213.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_wrap</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_norm</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,77 +41,300 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_wrap</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_norm<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:gaae74b7519ef59ecdd72697db94d130f7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaae74b7519ef59ecdd72697db94d130f7"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gaae74b7519ef59ecdd72697db94d130f7">clamp</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:gaae74b7519ef59ecdd72697db94d130f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ebbf9029b98578fcaa682939ced093a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga5ebbf9029b98578fcaa682939ced093a"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga5ebbf9029b98578fcaa682939ced093a">mirrorRepeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:ga5ebbf9029b98578fcaa682939ced093a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae841d5a9607e9e306b39f79e533b406c"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gae841d5a9607e9e306b39f79e533b406c"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gae841d5a9607e9e306b39f79e533b406c">repeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:gae841d5a9607e9e306b39f79e533b406c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9affa2e0e963514b276b54b778986145"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga9affa2e0e963514b276b54b778986145"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga9affa2e0e963514b276b54b778986145">distance2</a> (T const &amp;p0, T const &amp;p1)</td></tr>
<tr class="separator:ga9affa2e0e963514b276b54b778986145"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc6f577012065509f8fc332656ad81f0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gafc6f577012065509f8fc332656ad81f0"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gafc6f577012065509f8fc332656ad81f0">distance2</a> (genType const &amp;p0, genType const &amp;p1)</td></tr>
<tr class="separator:gafc6f577012065509f8fc332656ad81f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee37a0d793d114a7d2e46061cfedade1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gaee37a0d793d114a7d2e46061cfedade1"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gaee37a0d793d114a7d2e46061cfedade1">l1Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:gaee37a0d793d114a7d2e46061cfedade1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae89433808d9f6c96bef5795995774e44"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gae89433808d9f6c96bef5795995774e44"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gae89433808d9f6c96bef5795995774e44">l1Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:gae89433808d9f6c96bef5795995774e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga21e67fc40ab2c499a3d7ff5dda861bd1">l2Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac674c1f4077f9b6a42e6b725438c4221"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gac674c1f4077f9b6a42e6b725438c4221"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gac674c1f4077f9b6a42e6b725438c4221">l2Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:gac674c1f4077f9b6a42e6b725438c4221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga1d8568485d8bbe6593dbbc2221659dfe">length2</a> (T const &amp;x)</td></tr>
<tr class="separator:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e489e9efce12a44b753548c15b59c06"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga2e489e9efce12a44b753548c15b59c06"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga2e489e9efce12a44b753548c15b59c06">length2</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga2e489e9efce12a44b753548c15b59c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f78d8422258745062e300b76e3c0b85"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga5f78d8422258745062e300b76e3c0b85"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga5f78d8422258745062e300b76e3c0b85">lxNorm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y, unsigned int Depth)</td></tr>
<tr class="separator:ga5f78d8422258745062e300b76e3c0b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga4a40dbc06c508af5e21a66d2dd4c9f9d">lxNorm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, unsigned int Depth)</td></tr>
<tr class="separator:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Wrapping mode of texture coordinates. </p>
<p>&lt;<a class="el" href="a00124.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/wrap.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Various ways to compute vector norms. </p>
<p>&lt;<a class="el" href="a00085.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/norm.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaae74b7519ef59ecdd72697db94d130f7"></a>
<a class="anchor" id="ga9affa2e0e963514b276b54b778986145"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::clamp </td>
<td class="memname">T glm::distance2 </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gafc6f577012065509f8fc332656ad81f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::distance2 </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gaee37a0d793d114a7d2e46061cfedade1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::l1Norm </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the L1 norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gae89433808d9f6c96bef5795995774e44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::l1Norm </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_CLAMP OpenGL wrap mode From GLM_GTX_wrap extension. </p>
<p>Returns the L1 norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga5ebbf9029b98578fcaa682939ced093a"></a>
<a class="anchor" id="ga21e67fc40ab2c499a3d7ff5dda861bd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::mirrorRepeat </td>
<td class="memname">T glm::l2Norm </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the L2 norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gac674c1f4077f9b6a42e6b725438c4221"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::l2Norm </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_MIRROR_REPEAT OpenGL wrap mode From GLM_GTX_wrap extension. </p>
<p>Returns the L2 norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gae841d5a9607e9e306b39f79e533b406c"></a>
<a class="anchor" id="ga1d8568485d8bbe6593dbbc2221659dfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::repeat </td>
<td class="memname">T glm::length2 </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Texcoord</em></td><td>)</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_REPEAT OpenGL wrap mode From GLM_GTX_wrap extension. </p>
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga2e489e9efce12a44b753548c15b59c06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::length2 </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 the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga5f78d8422258745062e300b76e3c0b85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::lxNorm </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>Depth</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the L norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga4a40dbc06c508af5e21a66d2dd4c9f9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::lxNorm </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>Depth</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the L norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
@@ -114,7 +343,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>