Platformer in OpenGL
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

325 lines
17 KiB

5 years ago
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>0.9.9 API documenation: GLM_GTX_fast_square_root</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">0.9.9 API documenation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.14 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_GTX_fast_square_root<div class="ingroups"><a class="el" href="a00705.html">Experimental extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  73. <tr class="memitem:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#gaac333418d0c4e0cc6d3d219ed606c238">fastDistance</a> (genType x, genType y)</td></tr>
  74. <tr class="separator:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga42d3e771fa7cb3c60d828e315829df19"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  76. <tr class="memitem:ga42d3e771fa7cb3c60d828e315829df19"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a> (vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</td></tr>
  77. <tr class="separator:ga42d3e771fa7cb3c60d828e315829df19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  79. <tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#ga7f081b14d9c7035c8714eba5f7f75a8f">fastInverseSqrt</a> (genType x)</td></tr>
  80. <tr class="separator:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  82. <tr class="memitem:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  83. <tr class="separator:gadcd7be12b1e5ee182141359d4c45dd24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  85. <tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#gafe697d6287719538346bbdf8b1367c59">fastLength</a> (genType x)</td></tr>
  86. <tr class="separator:gafe697d6287719538346bbdf8b1367c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ga90f66be92ef61e705c005e7b3209edb8"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:ga90f66be92ef61e705c005e7b3209edb8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  89. <tr class="separator:ga90f66be92ef61e705c005e7b3209edb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  91. <tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">fastNormalize</a> (genType const &amp;x)</td></tr>
  92. <tr class="separator:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  94. <tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#ga6c460e9414a50b2fc455c8f64c86cdc9">fastSqrt</a> (genType x)</td></tr>
  95. <tr class="separator:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  97. <tr class="memitem:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00741.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a> (vec&lt; L, T, Q &gt; const &amp;x)</td></tr>
  98. <tr class="separator:gae83f0c03614f73eae5478c5b6274ee6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <p>Include &lt;<a class="el" href="a00488.html" title="GLM_GTX_fast_square_root ">glm/gtx/fast_square_root.hpp</a>&gt; to use the features of this extension. </p>
  102. <p>Fast but less accurate implementations of square root based functions.</p><ul>
  103. <li>Sqrt optimisation based on Newton's method, www.gamedev.net/community/forums/topic.asp?topic id=139956 </li>
  104. </ul>
  105. <h2 class="groupheader">Function Documentation</h2>
  106. <a id="gaac333418d0c4e0cc6d3d219ed606c238"></a>
  107. <h2 class="memtitle"><span class="permalink"><a href="#gaac333418d0c4e0cc6d3d219ed606c238">&#9670;&nbsp;</a></span>fastDistance() <span class="overload">[1/2]</span></h2>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">GLM_FUNC_DECL genType glm::fastDistance </td>
  113. <td>(</td>
  114. <td class="paramtype">genType&#160;</td>
  115. <td class="paramname"><em>x</em>, </td>
  116. </tr>
  117. <tr>
  118. <td class="paramkey"></td>
  119. <td></td>
  120. <td class="paramtype">genType&#160;</td>
  121. <td class="paramname"><em>y</em>&#160;</td>
  122. </tr>
  123. <tr>
  124. <td></td>
  125. <td>)</td>
  126. <td></td><td></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Faster than the common distance function but less accurate. </p>
  131. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  132. </div>
  133. </div>
  134. <a id="ga42d3e771fa7cb3c60d828e315829df19"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#ga42d3e771fa7cb3c60d828e315829df19">&#9670;&nbsp;</a></span>fastDistance() <span class="overload">[2/2]</span></h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">GLM_FUNC_DECL T glm::fastDistance </td>
  141. <td>(</td>
  142. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  143. <td class="paramname"><em>x</em>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  149. <td class="paramname"><em>y</em>&#160;</td>
  150. </tr>
  151. <tr>
  152. <td></td>
  153. <td>)</td>
  154. <td></td><td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>Faster than the common distance function but less accurate. </p>
  159. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  160. </div>
  161. </div>
  162. <a id="ga7f081b14d9c7035c8714eba5f7f75a8f"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#ga7f081b14d9c7035c8714eba5f7f75a8f">&#9670;&nbsp;</a></span>fastInverseSqrt() <span class="overload">[1/2]</span></h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">GLM_FUNC_DECL genType glm::fastInverseSqrt </td>
  169. <td>(</td>
  170. <td class="paramtype">genType&#160;</td>
  171. <td class="paramname"><em>x</em></td><td>)</td>
  172. <td></td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Faster than the common inversesqrt function but less accurate. </p>
  177. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  178. </div>
  179. </div>
  180. <a id="gadcd7be12b1e5ee182141359d4c45dd24"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#gadcd7be12b1e5ee182141359d4c45dd24">&#9670;&nbsp;</a></span>fastInverseSqrt() <span class="overload">[2/2]</span></h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::fastInverseSqrt </td>
  187. <td>(</td>
  188. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  189. <td class="paramname"><em>x</em></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Faster than the common inversesqrt function but less accurate. </p>
  195. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  196. </div>
  197. </div>
  198. <a id="gafe697d6287719538346bbdf8b1367c59"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#gafe697d6287719538346bbdf8b1367c59">&#9670;&nbsp;</a></span>fastLength() <span class="overload">[1/2]</span></h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">GLM_FUNC_DECL genType glm::fastLength </td>
  205. <td>(</td>
  206. <td class="paramtype">genType&#160;</td>
  207. <td class="paramname"><em>x</em></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Faster than the common length function but less accurate. </p>
  213. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  214. </div>
  215. </div>
  216. <a id="ga90f66be92ef61e705c005e7b3209edb8"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#ga90f66be92ef61e705c005e7b3209edb8">&#9670;&nbsp;</a></span>fastLength() <span class="overload">[2/2]</span></h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">GLM_FUNC_DECL T glm::fastLength </td>
  223. <td>(</td>
  224. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  225. <td class="paramname"><em>x</em></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>Faster than the common length function but less accurate. </p>
  231. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  232. </div>
  233. </div>
  234. <a id="ga3b02c1d6e0c754144e2f1e110bf9f16c"></a>
  235. <h2 class="memtitle"><span class="permalink"><a href="#ga3b02c1d6e0c754144e2f1e110bf9f16c">&#9670;&nbsp;</a></span>fastNormalize()</h2>
  236. <div class="memitem">
  237. <div class="memproto">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname">GLM_FUNC_DECL genType glm::fastNormalize </td>
  241. <td>(</td>
  242. <td class="paramtype">genType const &amp;&#160;</td>
  243. <td class="paramname"><em>x</em></td><td>)</td>
  244. <td></td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Faster than the common normalize function but less accurate. </p>
  249. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  250. </div>
  251. </div>
  252. <a id="ga6c460e9414a50b2fc455c8f64c86cdc9"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#ga6c460e9414a50b2fc455c8f64c86cdc9">&#9670;&nbsp;</a></span>fastSqrt() <span class="overload">[1/2]</span></h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">GLM_FUNC_DECL genType glm::fastSqrt </td>
  259. <td>(</td>
  260. <td class="paramtype">genType&#160;</td>
  261. <td class="paramname"><em>x</em></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Faster than the common sqrt function but less accurate. </p>
  267. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  268. </div>
  269. </div>
  270. <a id="gae83f0c03614f73eae5478c5b6274ee6d"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#gae83f0c03614f73eae5478c5b6274ee6d">&#9670;&nbsp;</a></span>fastSqrt() <span class="overload">[2/2]</span></h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::fastSqrt </td>
  277. <td>(</td>
  278. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  279. <td class="paramname"><em>x</em></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>Faster than the common sqrt function but less accurate. </p>
  285. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00741.html" title="Include &lt;glm/gtx/fast_square_root.hpp&gt; to use the features of this extension. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  286. </div>
  287. </div>
  288. </div><!-- contents -->
  289. <!-- start footer part -->
  290. <hr class="footer"/><address class="footer"><small>
  291. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  292. <img class="footer" src="doxygen.png" alt="doxygen"/>
  293. </a> 1.8.14
  294. </small></address>
  295. </body>
  296. </html>