mirror of
https://github.com/g-truc/glm.git
synced 2024-11-10 12:41:54 +00:00
344 lines
16 KiB
HTML
344 lines
16 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"/>
|
|
<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_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>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.9 API documenation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTX_norm<div class="ingroups"><a class="el" href="a00154.html">GTX Extensions (Experimental)</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Various ways to compute vector norms.
|
|
<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:ga647d2602008801d6ed78f9708eb439cc"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga647d2602008801d6ed78f9708eb439cc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga647d2602008801d6ed78f9708eb439cc">distance2</a> (vecType< T, P > const &p0, vecType< T, P > const &p1)</td></tr>
|
|
<tr class="memdesc:ga647d2602008801d6ed78f9708eb439cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). <a href="a00211.html#ga647d2602008801d6ed78f9708eb439cc">More...</a><br /></td></tr>
|
|
<tr class="separator:ga647d2602008801d6ed78f9708eb439cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaebe5a39b06e262e615622129f37da4f4"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:gaebe5a39b06e262e615622129f37da4f4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gaebe5a39b06e262e615622129f37da4f4">l1Norm</a> (tvec3< T, P > const &x, tvec3< T, P > const &y)</td></tr>
|
|
<tr class="memdesc:gaebe5a39b06e262e615622129f37da4f4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L1 norm between x and y. <a href="a00211.html#gaebe5a39b06e262e615622129f37da4f4">More...</a><br /></td></tr>
|
|
<tr class="separator:gaebe5a39b06e262e615622129f37da4f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a> (tvec3< T, P > const &v)</td></tr>
|
|
<tr class="memdesc:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L1 norm of v. <a href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6d5964f09cdb43803496a5ee3ced71cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gafa6fbbc99cd44d81bf030e74eaf7ad64">l2Norm</a> (tvec3< T, P > const &x, tvec3< T, P > const &y)</td></tr>
|
|
<tr class="memdesc:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L2 norm between x and y. <a href="a00211.html#gafa6fbbc99cd44d81bf030e74eaf7ad64">More...</a><br /></td></tr>
|
|
<tr class="separator:gafa6fbbc99cd44d81bf030e74eaf7ad64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a> (tvec3< T, P > const &x)</td></tr>
|
|
<tr class="memdesc:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L2 norm of v. <a href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">More...</a><br /></td></tr>
|
|
<tr class="separator:ga0a8cb8a0ce88d1d977de23209bf04610"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
|
<tr class="memitem:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga6d326d62fd9b7f4f0a1b79e56492a7e4">length2</a> (vecType< T, P > const &x)</td></tr>
|
|
<tr class="memdesc:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the squared length of x. <a href="a00211.html#ga6d326d62fd9b7f4f0a1b79e56492a7e4">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6d326d62fd9b7f4f0a1b79e56492a7e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga932bb0854e5c5a6ab5a14b023c451ca7">lxNorm</a> (tvec3< T, P > const &x, tvec3< T, P > const &y, unsigned int Depth)</td></tr>
|
|
<tr class="memdesc:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L norm between x and y. <a href="a00211.html#ga932bb0854e5c5a6ab5a14b023c451ca7">More...</a><br /></td></tr>
|
|
<tr class="separator:ga932bb0854e5c5a6ab5a14b023c451ca7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
|
<tr class="memitem:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a> (tvec3< T, P > const &x, unsigned int Depth)</td></tr>
|
|
<tr class="memdesc:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L norm of v. <a href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">More...</a><br /></td></tr>
|
|
<tr class="separator:gaab931b0d1acfe2f9c1cb78311edf24fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Various ways to compute vector norms. </p>
|
|
<p><<a class="el" href="a00075.html" title="GLM_GTX_norm ">glm/gtx/norm.hpp</a>> need to be included to use these functionalities. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga647d2602008801d6ed78f9708eb439cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::distance2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > const & </td>
|
|
<td class="paramname"><em>p0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vecType< T, P > 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., length2(p0 - p1). </p>
|
|
<p>From GLM_GTX_norm extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaebe5a39b06e262e615622129f37da4f4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">tvec3< T, P > 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="ga6d5964f09cdb43803496a5ee3ced71cb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > 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="gafa6fbbc99cd44d81bf030e74eaf7ad64"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">tvec3< T, P > 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="ga0a8cb8a0ce88d1d977de23209bf04610"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > 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="ga6d326d62fd9b7f4f0a1b79e56492a7e4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::length2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vecType< T, P > 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="ga932bb0854e5c5a6ab5a14b023c451ca7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">tvec3< T, P > 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="gaab931b0d1acfe2f9c1cb78311edf24fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tvec3< T, P > 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><!-- contents -->
|
|
<!-- start footer part -->
|
|
<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.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|