mirror of
https://github.com/g-truc/glm.git
synced 2024-11-23 01:14:34 +00:00
379 lines
15 KiB
HTML
379 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
|
|
<title>GLM_GTX_norm: Vector norm calculations</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div! -->
|
|
|
|
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<!-- Generated by Doxygen 1.7.5.1 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTX_norm: Vector norm calculations</div> </div>
|
|
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga9affa2e0e963514b276b54b778986145">distance2</a> (T const &p0, T const &p1)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#gafc6f577012065509f8fc332656ad81f0">distance2</a> (genType const &p0, genType const &p1)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga8783c302b3fc787dbdb120d77c01ca1a">l1Norm</a> (detail::tvec3< T > const &x, detail::tvec3< T > const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga44ba61367ab9578787afad618f517e1d">l1Norm</a> (detail::tvec3< T > const &v)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga1b1932b8578f610af3ab377b5bd50d1b">l2Norm</a> (detail::tvec3< T > const &x, detail::tvec3< T > const &y)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#gad0ca60b06f65b43964bd94f546efde06">l2Norm</a> (detail::tvec3< T > const &x)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga1d8568485d8bbe6593dbbc2221659dfe">length2</a> (T const &x)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga2e489e9efce12a44b753548c15b59c06">length2</a> (genType const &x)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga2d9882f01bf0def991047f712dede6ba">length2</a> (detail::tquat< T > const &q)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#ga23c0a4fcfa19b7f7ba3e39bfa9c56d10">lxNorm</a> (detail::tvec3< T > const &x, detail::tvec3< T > const &y, unsigned int Depth)</td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00185.html#gaeab4d00cc31b8f48eae904db846eaf61">lxNorm</a> (detail::tvec3< T > const &x, unsigned int Depth)</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<p>Various way to compute vector norms. </p>
|
|
<p><<a class="el" href="a00065.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/norm.hpp</a>> need to be included to use these functionalities. </p>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="ga9affa2e0e963514b276b54b778986145"></a><!-- doxytag: member="glm::distance2" ref="ga9affa2e0e963514b276b54b778986145" args="(T const &p0, T const &p1)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::distance2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>p0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>p1</em> </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><!-- doxytag: member="glm::distance2" ref="gafc6f577012065509f8fc332656ad81f0" args="(genType const &p0, genType const &p1)" -->
|
|
<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 & </td>
|
|
<td class="paramname"><em>p0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">genType const & </td>
|
|
<td class="paramname"><em>p1</em> </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="ga8783c302b3fc787dbdb120d77c01ca1a"></a><!-- doxytag: member="glm::l1Norm" ref="ga8783c302b3fc787dbdb120d77c01ca1a" args="(detail::tvec3< T > const &x, detail::tvec3< T > const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::l1Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>y</em> </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="ga44ba61367ab9578787afad618f517e1d"></a><!-- doxytag: member="glm::l1Norm" ref="ga44ba61367ab9578787afad618f517e1d" args="(detail::tvec3< T > const &v)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::l1Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the L1 norm of v. </p>
|
|
<p>From GLM_GTX_norm extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1b1932b8578f610af3ab377b5bd50d1b"></a><!-- doxytag: member="glm::l2Norm" ref="ga1b1932b8578f610af3ab377b5bd50d1b" args="(detail::tvec3< T > const &x, detail::tvec3< T > const &y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::l2Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>y</em> </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="gad0ca60b06f65b43964bd94f546efde06"></a><!-- doxytag: member="glm::l2Norm" ref="gad0ca60b06f65b43964bd94f546efde06" args="(detail::tvec3< T > const &x)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::l2Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the L2 norm of v. </p>
|
|
<p>From GLM_GTX_norm extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1d8568485d8bbe6593dbbc2221659dfe"></a><!-- doxytag: member="glm::length2" ref="ga1d8568485d8bbe6593dbbc2221659dfe" args="(T const &x)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::length2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const & </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="ga2e489e9efce12a44b753548c15b59c06"></a><!-- doxytag: member="glm::length2" ref="ga2e489e9efce12a44b753548c15b59c06" args="(genType const &x)" -->
|
|
<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 & </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="ga2d9882f01bf0def991047f712dede6ba"></a><!-- doxytag: member="glm::length2" ref="ga2d9882f01bf0def991047f712dede6ba" args="(detail::tquat< T > const &q)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::length2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tquat< T > const & </td>
|
|
<td class="paramname"><em>q</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="ga23c0a4fcfa19b7f7ba3e39bfa9c56d10"></a><!-- doxytag: member="glm::lxNorm" ref="ga23c0a4fcfa19b7f7ba3e39bfa9c56d10" args="(detail::tvec3< T > const &x, detail::tvec3< T > const &y, unsigned int Depth)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::lxNorm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>Depth</em> </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="gaeab4d00cc31b8f48eae904db846eaf61"></a><!-- doxytag: member="glm::lxNorm" ref="gaeab4d00cc31b8f48eae904db846eaf61" args="(detail::tvec3< T > const &x, unsigned int Depth)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T glm::lxNorm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">detail::tvec3< T > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>Depth</em> </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>
|
|
</div>
|
|
|
|
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.7.5.1
|
|
</small></address>
|
|
|
|
</body>
|
|
</html>
|