mirror of
https://github.com/g-truc/glm.git
synced 2024-11-10 12:41:54 +00:00
333 lines
19 KiB
HTML
333 lines
19 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_fast_square_root</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_fast_square_root<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Include <<a class="el" href="a00031.html" title="GLM_GTX_fast_square_root ">glm/gtx/fast_square_root.hpp</a>> 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:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gaac333418d0c4e0cc6d3d219ed606c238">fastDistance</a> (genType x, genType y)</td></tr>
|
|
<tr class="memdesc:gaac333418d0c4e0cc6d3d219ed606c238"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common distance function but less accurate. <a href="a00191.html#gaac333418d0c4e0cc6d3d219ed606c238">More...</a><br /></td></tr>
|
|
<tr class="separator:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga42d3e771fa7cb3c60d828e315829df19"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga42d3e771fa7cb3c60d828e315829df19"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a> (vec< L, T, Q > const &x, vec< L, T, Q > const &y)</td></tr>
|
|
<tr class="memdesc:ga42d3e771fa7cb3c60d828e315829df19"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common distance function but less accurate. <a href="a00191.html#ga42d3e771fa7cb3c60d828e315829df19">More...</a><br /></td></tr>
|
|
<tr class="separator:ga42d3e771fa7cb3c60d828e315829df19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga7f081b14d9c7035c8714eba5f7f75a8f">fastInverseSqrt</a> (genType x)</td></tr>
|
|
<tr class="memdesc:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common inversesqrt function but less accurate. <a href="a00191.html#ga7f081b14d9c7035c8714eba5f7f75a8f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a> (vec< L, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:gadcd7be12b1e5ee182141359d4c45dd24"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common inversesqrt function but less accurate. <a href="a00191.html#gadcd7be12b1e5ee182141359d4c45dd24">More...</a><br /></td></tr>
|
|
<tr class="separator:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gafe697d6287719538346bbdf8b1367c59">fastLength</a> (genType x)</td></tr>
|
|
<tr class="memdesc:gafe697d6287719538346bbdf8b1367c59"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common length function but less accurate. <a href="a00191.html#gafe697d6287719538346bbdf8b1367c59">More...</a><br /></td></tr>
|
|
<tr class="separator:gafe697d6287719538346bbdf8b1367c59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga90f66be92ef61e705c005e7b3209edb8"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga90f66be92ef61e705c005e7b3209edb8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a> (vec< L, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:ga90f66be92ef61e705c005e7b3209edb8"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common length function but less accurate. <a href="a00191.html#ga90f66be92ef61e705c005e7b3209edb8">More...</a><br /></td></tr>
|
|
<tr class="separator:ga90f66be92ef61e705c005e7b3209edb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">fastNormalize</a> (genType const &x)</td></tr>
|
|
<tr class="memdesc:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common normalize function but less accurate. <a href="a00191.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#ga6c460e9414a50b2fc455c8f64c86cdc9">fastSqrt</a> (genType x)</td></tr>
|
|
<tr class="memdesc:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common sqrt function but less accurate. <a href="a00191.html#ga6c460e9414a50b2fc455c8f64c86cdc9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00191.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a> (vec< L, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:gae83f0c03614f73eae5478c5b6274ee6d"><td class="mdescLeft"> </td><td class="mdescRight">Faster than the common sqrt function but less accurate. <a href="a00191.html#gae83f0c03614f73eae5478c5b6274ee6d">More...</a><br /></td></tr>
|
|
<tr class="separator:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Include <<a class="el" href="a00031.html" title="GLM_GTX_fast_square_root ">glm/gtx/fast_square_root.hpp</a>> to use the features of this extension. </p>
|
|
<p>Fast but less accurate implementations of square root based functions.</p><ul>
|
|
<li>Sqrt optimisation based on Newton's method, www.gamedev.net/community/forums/topic.asp?topic id=139956 </li>
|
|
</ul>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaac333418d0c4e0cc6d3d219ed606c238"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::fastDistance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">genType </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>Faster than the common distance function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga42d3e771fa7cb3c60d828e315829df19"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::fastDistance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< L, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< L, T, Q > 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>Faster than the common distance function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7f081b14d9c7035c8714eba5f7f75a8f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::fastInverseSqrt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common inversesqrt function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadcd7be12b1e5ee182141359d4c45dd24"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::fastInverseSqrt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< L, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common inversesqrt function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafe697d6287719538346bbdf8b1367c59"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::fastLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common length function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga90f66be92ef61e705c005e7b3209edb8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::fastLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< L, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common length function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3b02c1d6e0c754144e2f1e110bf9f16c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::fastNormalize </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>Faster than the common normalize function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6c460e9414a50b2fc455c8f64c86cdc9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::fastSqrt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common sqrt function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae83f0c03614f73eae5478c5b6274ee6d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::fastSqrt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< L, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Faster than the common sqrt function but less accurate. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00191.html" title="Include <glm/gtx/fast_square_root.hpp> to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
|
|
|
|
</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>
|