_math_8h.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: Jolt/Math/Math.h File Reference</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. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('_math_8h.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#func-members">Functions</a> </div>
  108. <div class="headertitle"><div class="title">Math.h File Reference</div></div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <p><a href="_math_8h_source.html">Go to the source code of this file.</a></p>
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  114. Functions</h2></td></tr>
  115. <tr class="memitem:a636689581f2a6ce1d3030dc4dd83b2f5" id="r_a636689581f2a6ce1d3030dc4dd83b2f5"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a636689581f2a6ce1d3030dc4dd83b2f5">DegreesToRadians</a> (float inV)</td></tr>
  116. <tr class="memdesc:a636689581f2a6ce1d3030dc4dd83b2f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value from degrees to radians. <br /></td></tr>
  117. <tr class="separator:a636689581f2a6ce1d3030dc4dd83b2f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a6ecf6194532e807dd457ef28defa1991" id="r_a6ecf6194532e807dd457ef28defa1991"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ecf6194532e807dd457ef28defa1991">RadiansToDegrees</a> (float inV)</td></tr>
  119. <tr class="memdesc:a6ecf6194532e807dd457ef28defa1991"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value from radians to degrees. <br /></td></tr>
  120. <tr class="separator:a6ecf6194532e807dd457ef28defa1991"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a50121c6b962bb60d907d4f4c596935c4" id="r_a50121c6b962bb60d907d4f4c596935c4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50121c6b962bb60d907d4f4c596935c4">CenterAngleAroundZero</a> (float inV)</td></tr>
  122. <tr class="memdesc:a50121c6b962bb60d907d4f4c596935c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert angle in radians to the range \([-\pi, \pi]\). <br /></td></tr>
  123. <tr class="separator:a50121c6b962bb60d907d4f4c596935c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a05be8f8200a1a67cbfacd3d16b17ac21" id="r_a05be8f8200a1a67cbfacd3d16b17ac21"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  125. <tr class="memitem:a05be8f8200a1a67cbfacd3d16b17ac21"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a05be8f8200a1a67cbfacd3d16b17ac21">Clamp</a> (T inV, T inMin, T inMax)</td></tr>
  126. <tr class="memdesc:a05be8f8200a1a67cbfacd3d16b17ac21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clamp a value between two values. <br /></td></tr>
  127. <tr class="separator:a05be8f8200a1a67cbfacd3d16b17ac21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a61379b8b743a16fe823daeebc1482570" id="r_a61379b8b743a16fe823daeebc1482570"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  129. <tr class="memitem:a61379b8b743a16fe823daeebc1482570"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a61379b8b743a16fe823daeebc1482570">Square</a> (T inV)</td></tr>
  130. <tr class="memdesc:a61379b8b743a16fe823daeebc1482570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Square a value. <br /></td></tr>
  131. <tr class="separator:a61379b8b743a16fe823daeebc1482570"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a6a1a326c0e5f6b61307d2458bcce0eb8" id="r_a6a1a326c0e5f6b61307d2458bcce0eb8"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  133. <tr class="memitem:a6a1a326c0e5f6b61307d2458bcce0eb8"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6a1a326c0e5f6b61307d2458bcce0eb8">Cubed</a> (T inV)</td></tr>
  134. <tr class="memdesc:a6a1a326c0e5f6b61307d2458bcce0eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns \(inV^3\). <br /></td></tr>
  135. <tr class="separator:a6a1a326c0e5f6b61307d2458bcce0eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a34ee8d229d5ba32162857cf660526a86" id="r_a34ee8d229d5ba32162857cf660526a86"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  137. <tr class="memitem:a34ee8d229d5ba32162857cf660526a86"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a34ee8d229d5ba32162857cf660526a86">Sign</a> (T inV)</td></tr>
  138. <tr class="memdesc:a34ee8d229d5ba32162857cf660526a86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the sign of a value. <br /></td></tr>
  139. <tr class="separator:a34ee8d229d5ba32162857cf660526a86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a531058b1613a4e5123a68a704673e1a2" id="r_a531058b1613a4e5123a68a704673e1a2"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  141. <tr class="memitem:a531058b1613a4e5123a68a704673e1a2"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a531058b1613a4e5123a68a704673e1a2">IsPowerOf2</a> (T inV)</td></tr>
  142. <tr class="memdesc:a531058b1613a4e5123a68a704673e1a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if inV is a power of 2. <br /></td></tr>
  143. <tr class="separator:a531058b1613a4e5123a68a704673e1a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:af4d371fa6a518ca5b81757dc225fae4d" id="r_af4d371fa6a518ca5b81757dc225fae4d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  145. <tr class="memitem:af4d371fa6a518ca5b81757dc225fae4d"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af4d371fa6a518ca5b81757dc225fae4d">AlignUp</a> (T inV, <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inAlignment)</td></tr>
  146. <tr class="memdesc:af4d371fa6a518ca5b81757dc225fae4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Align inV up to the next inAlignment bytes. <br /></td></tr>
  147. <tr class="separator:af4d371fa6a518ca5b81757dc225fae4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a92bab343999851b4ded776dd2a70c742" id="r_a92bab343999851b4ded776dd2a70c742"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  149. <tr class="memitem:a92bab343999851b4ded776dd2a70c742"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a92bab343999851b4ded776dd2a70c742">IsAligned</a> (T inV, <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inAlignment)</td></tr>
  150. <tr class="memdesc:a92bab343999851b4ded776dd2a70c742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if inV is inAlignment aligned. <br /></td></tr>
  151. <tr class="separator:a92bab343999851b4ded776dd2a70c742"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:aacba3fe18847d926ab86e86dbf94d219" id="r_aacba3fe18847d926ab86e86dbf94d219"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aacba3fe18847d926ab86e86dbf94d219">CountTrailingZeros</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inValue)</td></tr>
  153. <tr class="memdesc:aacba3fe18847d926ab86e86dbf94d219"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute number of trailing zero bits (how many low bits are zero) <br /></td></tr>
  154. <tr class="separator:aacba3fe18847d926ab86e86dbf94d219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:abd13b5df498e6de8a050b25766543658" id="r_abd13b5df498e6de8a050b25766543658"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd13b5df498e6de8a050b25766543658">CountLeadingZeros</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inValue)</td></tr>
  156. <tr class="memdesc:abd13b5df498e6de8a050b25766543658"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the number of leading zero bits (how many high bits are zero) <br /></td></tr>
  157. <tr class="separator:abd13b5df498e6de8a050b25766543658"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a59413d7cb307df1856ec71deb3cc1a5b" id="r_a59413d7cb307df1856ec71deb3cc1a5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59413d7cb307df1856ec71deb3cc1a5b">CountBits</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inValue)</td></tr>
  159. <tr class="memdesc:a59413d7cb307df1856ec71deb3cc1a5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Count the number of 1 bits in a value. <br /></td></tr>
  160. <tr class="separator:a59413d7cb307df1856ec71deb3cc1a5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ae0004008e30f155d5c7b71eafe3c4790" id="r_ae0004008e30f155d5c7b71eafe3c4790"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0004008e30f155d5c7b71eafe3c4790">GetNextPowerOf2</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inValue)</td></tr>
  162. <tr class="memdesc:ae0004008e30f155d5c7b71eafe3c4790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the next higher power of 2 of a value, or the value itself if the value is already a power of 2. <br /></td></tr>
  163. <tr class="separator:ae0004008e30f155d5c7b71eafe3c4790"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:ab2cbe30946edbf23887cfc1291025866" id="r_ab2cbe30946edbf23887cfc1291025866"><td class="memTemplParams" colspan="2">template&lt;class To , class From &gt; </td></tr>
  165. <tr class="memitem:ab2cbe30946edbf23887cfc1291025866"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE To&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab2cbe30946edbf23887cfc1291025866">BitCast</a> (const From &amp;inValue)</td></tr>
  166. <tr class="separator:ab2cbe30946edbf23887cfc1291025866"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <h2 class="groupheader">Function Documentation</h2>
  169. <a id="af4d371fa6a518ca5b81757dc225fae4d" name="af4d371fa6a518ca5b81757dc225fae4d"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#af4d371fa6a518ca5b81757dc225fae4d">&#9670;&#160;</a></span>AlignUp()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <div class="memtemplate">
  174. template&lt;typename T &gt; </div>
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">T AlignUp </td>
  181. <td>(</td>
  182. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inAlignment</em></span>&#160;)</td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Align inV up to the next inAlignment bytes. </p>
  197. </div>
  198. </div>
  199. <a id="ab2cbe30946edbf23887cfc1291025866" name="ab2cbe30946edbf23887cfc1291025866"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#ab2cbe30946edbf23887cfc1291025866">&#9670;&#160;</a></span>BitCast()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <div class="memtemplate">
  204. template&lt;class To , class From &gt; </div>
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">JPH_INLINE To BitCast </td>
  208. <td>(</td>
  209. <td class="paramtype">const From &amp;</td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. </div>
  215. </div>
  216. <a id="a50121c6b962bb60d907d4f4c596935c4" name="a50121c6b962bb60d907d4f4c596935c4"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#a50121c6b962bb60d907d4f4c596935c4">&#9670;&#160;</a></span>CenterAngleAroundZero()</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">float CenterAngleAroundZero </td>
  226. <td>(</td>
  227. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Convert angle in radians to the range \([-\pi, \pi]\). </p>
  238. </div>
  239. </div>
  240. <a id="a05be8f8200a1a67cbfacd3d16b17ac21" name="a05be8f8200a1a67cbfacd3d16b17ac21"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#a05be8f8200a1a67cbfacd3d16b17ac21">&#9670;&#160;</a></span>Clamp()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <div class="memtemplate">
  245. template&lt;typename T &gt; </div>
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">JPH_INLINE constexpr T Clamp </td>
  252. <td>(</td>
  253. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inMin</em></span>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inMax</em></span>&#160;)</td>
  264. </tr>
  265. </table>
  266. </td>
  267. <td class="mlabels-right">
  268. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Clamp a value between two values. </p>
  273. </div>
  274. </div>
  275. <a id="a59413d7cb307df1856ec71deb3cc1a5b" name="a59413d7cb307df1856ec71deb3cc1a5b"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a59413d7cb307df1856ec71deb3cc1a5b">&#9670;&#160;</a></span>CountBits()</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="mlabels">
  280. <tr>
  281. <td class="mlabels-left">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> CountBits </td>
  285. <td>(</td>
  286. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  287. <td></td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Count the number of 1 bits in a value. </p>
  297. </div>
  298. </div>
  299. <a id="abd13b5df498e6de8a050b25766543658" name="abd13b5df498e6de8a050b25766543658"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#abd13b5df498e6de8a050b25766543658">&#9670;&#160;</a></span>CountLeadingZeros()</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> CountLeadingZeros </td>
  309. <td>(</td>
  310. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Compute the number of leading zero bits (how many high bits are zero) </p>
  321. </div>
  322. </div>
  323. <a id="aacba3fe18847d926ab86e86dbf94d219" name="aacba3fe18847d926ab86e86dbf94d219"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#aacba3fe18847d926ab86e86dbf94d219">&#9670;&#160;</a></span>CountTrailingZeros()</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="mlabels">
  328. <tr>
  329. <td class="mlabels-left">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> CountTrailingZeros </td>
  333. <td>(</td>
  334. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </td>
  339. <td class="mlabels-right">
  340. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Compute number of trailing zero bits (how many low bits are zero) </p>
  345. </div>
  346. </div>
  347. <a id="a6a1a326c0e5f6b61307d2458bcce0eb8" name="a6a1a326c0e5f6b61307d2458bcce0eb8"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a6a1a326c0e5f6b61307d2458bcce0eb8">&#9670;&#160;</a></span>Cubed()</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <div class="memtemplate">
  352. template&lt;typename T &gt; </div>
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">JPH_INLINE constexpr T Cubed </td>
  359. <td>(</td>
  360. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  361. <td></td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Returns \(inV^3\). </p>
  371. </div>
  372. </div>
  373. <a id="a636689581f2a6ce1d3030dc4dd83b2f5" name="a636689581f2a6ce1d3030dc4dd83b2f5"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#a636689581f2a6ce1d3030dc4dd83b2f5">&#9670;&#160;</a></span>DegreesToRadians()</h2>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="mlabels">
  378. <tr>
  379. <td class="mlabels-left">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">JPH_INLINE constexpr float DegreesToRadians </td>
  383. <td>(</td>
  384. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  385. <td></td>
  386. </tr>
  387. </table>
  388. </td>
  389. <td class="mlabels-right">
  390. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. <p>Convert a value from degrees to radians. </p>
  395. </div>
  396. </div>
  397. <a id="ae0004008e30f155d5c7b71eafe3c4790" name="ae0004008e30f155d5c7b71eafe3c4790"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#ae0004008e30f155d5c7b71eafe3c4790">&#9670;&#160;</a></span>GetNextPowerOf2()</h2>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="mlabels">
  402. <tr>
  403. <td class="mlabels-left">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> GetNextPowerOf2 </td>
  407. <td>(</td>
  408. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </td>
  413. <td class="mlabels-right">
  414. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Get the next higher power of 2 of a value, or the value itself if the value is already a power of 2. </p>
  419. </div>
  420. </div>
  421. <a id="a92bab343999851b4ded776dd2a70c742" name="a92bab343999851b4ded776dd2a70c742"></a>
  422. <h2 class="memtitle"><span class="permalink"><a href="#a92bab343999851b4ded776dd2a70c742">&#9670;&#160;</a></span>IsAligned()</h2>
  423. <div class="memitem">
  424. <div class="memproto">
  425. <div class="memtemplate">
  426. template&lt;typename T &gt; </div>
  427. <table class="mlabels">
  428. <tr>
  429. <td class="mlabels-left">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname">bool IsAligned </td>
  433. <td>(</td>
  434. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span>, </td>
  435. </tr>
  436. <tr>
  437. <td class="paramkey"></td>
  438. <td></td>
  439. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inAlignment</em></span>&#160;)</td>
  440. </tr>
  441. </table>
  442. </td>
  443. <td class="mlabels-right">
  444. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  445. </tr>
  446. </table>
  447. </div><div class="memdoc">
  448. <p>Check if inV is inAlignment aligned. </p>
  449. </div>
  450. </div>
  451. <a id="a531058b1613a4e5123a68a704673e1a2" name="a531058b1613a4e5123a68a704673e1a2"></a>
  452. <h2 class="memtitle"><span class="permalink"><a href="#a531058b1613a4e5123a68a704673e1a2">&#9670;&#160;</a></span>IsPowerOf2()</h2>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <div class="memtemplate">
  456. template&lt;typename T &gt; </div>
  457. <table class="mlabels">
  458. <tr>
  459. <td class="mlabels-left">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">bool IsPowerOf2 </td>
  463. <td>(</td>
  464. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </td>
  469. <td class="mlabels-right">
  470. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. <p>Check if inV is a power of 2. </p>
  475. </div>
  476. </div>
  477. <a id="a6ecf6194532e807dd457ef28defa1991" name="a6ecf6194532e807dd457ef28defa1991"></a>
  478. <h2 class="memtitle"><span class="permalink"><a href="#a6ecf6194532e807dd457ef28defa1991">&#9670;&#160;</a></span>RadiansToDegrees()</h2>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="mlabels">
  482. <tr>
  483. <td class="mlabels-left">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">JPH_INLINE constexpr float RadiansToDegrees </td>
  487. <td>(</td>
  488. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  489. <td></td>
  490. </tr>
  491. </table>
  492. </td>
  493. <td class="mlabels-right">
  494. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Convert a value from radians to degrees. </p>
  499. </div>
  500. </div>
  501. <a id="a34ee8d229d5ba32162857cf660526a86" name="a34ee8d229d5ba32162857cf660526a86"></a>
  502. <h2 class="memtitle"><span class="permalink"><a href="#a34ee8d229d5ba32162857cf660526a86">&#9670;&#160;</a></span>Sign()</h2>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <div class="memtemplate">
  506. template&lt;typename T &gt; </div>
  507. <table class="mlabels">
  508. <tr>
  509. <td class="mlabels-left">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname">JPH_INLINE constexpr T Sign </td>
  513. <td>(</td>
  514. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  515. <td></td>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p>Get the sign of a value. </p>
  525. </div>
  526. </div>
  527. <a id="a61379b8b743a16fe823daeebc1482570" name="a61379b8b743a16fe823daeebc1482570"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#a61379b8b743a16fe823daeebc1482570">&#9670;&#160;</a></span>Square()</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <div class="memtemplate">
  532. template&lt;typename T &gt; </div>
  533. <table class="mlabels">
  534. <tr>
  535. <td class="mlabels-left">
  536. <table class="memname">
  537. <tr>
  538. <td class="memname">JPH_INLINE constexpr T Square </td>
  539. <td>(</td>
  540. <td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  541. <td></td>
  542. </tr>
  543. </table>
  544. </td>
  545. <td class="mlabels-right">
  546. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. <p>Square a value. </p>
  551. </div>
  552. </div>
  553. </div><!-- contents -->
  554. </div><!-- doc-content -->
  555. <!-- start footer part -->
  556. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  557. <ul>
  558. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_aa37033c5611f3a5cff668cf59181100.html">Math</a></li><li class="navelem"><a class="el" href="_math_8h.html">Math.h</a></li>
  559. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  560. </ul>
  561. </div>
  562. </body>
  563. </html>