_memory_8h.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  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/Core/Memory.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('_memory_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="#define-members">Macros</a> &#124;
  108. <a href="#typedef-members">Typedefs</a> &#124;
  109. <a href="#func-members">Functions</a> &#124;
  110. <a href="#var-members">Variables</a> </div>
  111. <div class="headertitle"><div class="title">Memory.h File Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p><a href="_memory_8h_source.html">Go to the source code of this file.</a></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  117. Macros</h2></td></tr>
  118. <tr class="memitem:adf0d5d2601d9295abad305607595a7c9" id="r_adf0d5d2601d9295abad305607595a7c9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf0d5d2601d9295abad305607595a7c9">JPH_INTERNAL_DEFAULT_ALLOCATE</a>(size)</td></tr>
  119. <tr class="separator:adf0d5d2601d9295abad305607595a7c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a59e48c2bba4ef31501a21fa76e2bd0ad" id="r_a59e48c2bba4ef31501a21fa76e2bd0ad"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a>(pointer)</td></tr>
  121. <tr class="separator:a59e48c2bba4ef31501a21fa76e2bd0ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a91074fb218fe28954a0938c099ddd9e0" id="r_a91074fb218fe28954a0938c099ddd9e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></td></tr>
  123. <tr class="memdesc:a91074fb218fe28954a0938c099ddd9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to override the new and delete functions. <br /></td></tr>
  124. <tr class="separator:a91074fb218fe28954a0938c099ddd9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table><table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
  127. Typedefs</h2></td></tr>
  128. <tr class="memitem:af18828908838938f4deb92fbde4b3015" id="r_af18828908838938f4deb92fbde4b3015"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af18828908838938f4deb92fbde4b3015">AllocateFunction</a> = void *(*)(size_t inSize)</td></tr>
  129. <tr class="separator:af18828908838938f4deb92fbde4b3015"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a173beb7a0579a0dc288c66cc87d693ff" id="r_a173beb7a0579a0dc288c66cc87d693ff"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a173beb7a0579a0dc288c66cc87d693ff">ReallocateFunction</a> = void *(*)(void *inBlock, size_t inOldSize, size_t inNewSize)</td></tr>
  131. <tr class="memdesc:a173beb7a0579a0dc288c66cc87d693ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reallocate memory. inBlock can be nullptr in which case it must behave as a memory allocation. <br /></td></tr>
  132. <tr class="separator:a173beb7a0579a0dc288c66cc87d693ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a57f7cd4691f45cd3537b6e8fd3705eb0" id="r_a57f7cd4691f45cd3537b6e8fd3705eb0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57f7cd4691f45cd3537b6e8fd3705eb0">FreeFunction</a> = void (*)(void *inBlock)</td></tr>
  134. <tr class="memdesc:a57f7cd4691f45cd3537b6e8fd3705eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free memory. inBlock can be nullptr in which case it must do nothing. <br /></td></tr>
  135. <tr class="separator:a57f7cd4691f45cd3537b6e8fd3705eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a34745708a4f5ea89b7059f8f5952d3d6" id="r_a34745708a4f5ea89b7059f8f5952d3d6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34745708a4f5ea89b7059f8f5952d3d6">AlignedAllocateFunction</a> = void *(*)(size_t inSize, size_t inAlignment)</td></tr>
  137. <tr class="memdesc:a34745708a4f5ea89b7059f8f5952d3d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aligned memory allocation. <br /></td></tr>
  138. <tr class="separator:a34745708a4f5ea89b7059f8f5952d3d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ae5117b9da25ff2a21dfd5c159b36f1e1" id="r_ae5117b9da25ff2a21dfd5c159b36f1e1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5117b9da25ff2a21dfd5c159b36f1e1">AlignedFreeFunction</a> = void (*)(void *inBlock)</td></tr>
  140. <tr class="memdesc:ae5117b9da25ff2a21dfd5c159b36f1e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free aligned memory. inBlock can be nullptr in which case it must do nothing. <br /></td></tr>
  141. <tr class="separator:ae5117b9da25ff2a21dfd5c159b36f1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  144. Functions</h2></td></tr>
  145. <tr class="memitem:a6ae804b1b68490f6e032ef6e7d9fc93e" id="r_a6ae804b1b68490f6e032ef6e7d9fc93e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ae804b1b68490f6e032ef6e7d9fc93e">RegisterDefaultAllocator</a> ()</td></tr>
  146. <tr class="memdesc:a6ae804b1b68490f6e032ef6e7d9fc93e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register platform default allocation / free functions. <br /></td></tr>
  147. <tr class="separator:a6ae804b1b68490f6e032ef6e7d9fc93e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table><table class="memberdecls">
  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  150. Variables</h2></td></tr>
  151. <tr class="memitem:a8e44cb80cb8870970bc028513801205d" id="r_a8e44cb80cb8870970bc028513801205d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#af18828908838938f4deb92fbde4b3015">AllocateFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e44cb80cb8870970bc028513801205d">Allocate</a></td></tr>
  152. <tr class="separator:a8e44cb80cb8870970bc028513801205d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a8f705f8e1418d25f523b8aebf674322d" id="r_a8f705f8e1418d25f523b8aebf674322d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a173beb7a0579a0dc288c66cc87d693ff">ReallocateFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f705f8e1418d25f523b8aebf674322d">Reallocate</a></td></tr>
  154. <tr class="separator:a8f705f8e1418d25f523b8aebf674322d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:afff7dd3001cffbed9e362e4012b7f3af" id="r_afff7dd3001cffbed9e362e4012b7f3af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a57f7cd4691f45cd3537b6e8fd3705eb0">FreeFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afff7dd3001cffbed9e362e4012b7f3af">Free</a></td></tr>
  156. <tr class="separator:afff7dd3001cffbed9e362e4012b7f3af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a3aa09280dba8f254af17a487b8e407ff" id="r_a3aa09280dba8f254af17a487b8e407ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a34745708a4f5ea89b7059f8f5952d3d6">AlignedAllocateFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3aa09280dba8f254af17a487b8e407ff">AlignedAllocate</a></td></tr>
  158. <tr class="separator:a3aa09280dba8f254af17a487b8e407ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ade432661f00567a883e31a67e8d6dbb9" id="r_ade432661f00567a883e31a67e8d6dbb9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#ae5117b9da25ff2a21dfd5c159b36f1e1">AlignedFreeFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade432661f00567a883e31a67e8d6dbb9">AlignedFree</a></td></tr>
  160. <tr class="separator:ade432661f00567a883e31a67e8d6dbb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table>
  162. <h2 class="groupheader">Macro Definition Documentation</h2>
  163. <a id="adf0d5d2601d9295abad305607595a7c9" name="adf0d5d2601d9295abad305607595a7c9"></a>
  164. <h2 class="memtitle"><span class="permalink"><a href="#adf0d5d2601d9295abad305607595a7c9">&#9670;&#160;</a></span>JPH_INTERNAL_DEFAULT_ALLOCATE</h2>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">#define JPH_INTERNAL_DEFAULT_ALLOCATE</td>
  170. <td>(</td>
  171. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>size</em></span></td><td>)</td>
  172. <td></td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <b>Value:</b><div class="fragment"><div class="line">JPH::Allocate(size)</div>
  177. </div><!-- fragment -->
  178. </div>
  179. </div>
  180. <a id="a59e48c2bba4ef31501a21fa76e2bd0ad" name="a59e48c2bba4ef31501a21fa76e2bd0ad"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a59e48c2bba4ef31501a21fa76e2bd0ad">&#9670;&#160;</a></span>JPH_INTERNAL_DEFAULT_FREE</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">#define JPH_INTERNAL_DEFAULT_FREE</td>
  187. <td>(</td>
  188. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>pointer</em></span></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <b>Value:</b><div class="fragment"><div class="line">JPH::Free(pointer)</div>
  194. </div><!-- fragment -->
  195. </div>
  196. </div>
  197. <a id="a91074fb218fe28954a0938c099ddd9e0" name="a91074fb218fe28954a0938c099ddd9e0"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#a91074fb218fe28954a0938c099ddd9e0">&#9670;&#160;</a></span>JPH_OVERRIDE_NEW_DELETE</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">#define JPH_OVERRIDE_NEW_DELETE</td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <b>Value:</b><div class="fragment"><div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span> (<span class="keywordtype">size_t</span> inCount) { <span class="keywordflow">return</span> <a class="code hl_define" href="#adf0d5d2601d9295abad305607595a7c9">JPH_INTERNAL_DEFAULT_ALLOCATE</a>(inCount); } \</div>
  208. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span> *inPointer) <span class="keyword">noexcept</span> { <a class="code hl_define" href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a>(inPointer); } \</div>
  209. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">size_t</span> inSize) <span class="keyword">noexcept</span> { <a class="code hl_define" href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a>(inPointer); } \</div>
  210. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span>[] (<span class="keywordtype">size_t</span> inCount) { <span class="keywordflow">return</span> <a class="code hl_define" href="#adf0d5d2601d9295abad305607595a7c9">JPH_INTERNAL_DEFAULT_ALLOCATE</a>(inCount); } \</div>
  211. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>[] (<span class="keywordtype">void</span> *inPointer) <span class="keyword">noexcept</span> { <a class="code hl_define" href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a>(inPointer); } \</div>
  212. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>[] (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">size_t</span> inSize) <span class="keyword">noexcept</span>{ <a class="code hl_define" href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a>(inPointer); } \</div>
  213. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span> (<span class="keywordtype">size_t</span> inCount, std::align_val_t inAlignment) { <span class="keywordflow">return</span> JPH::AlignedAllocate(inCount, <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(inAlignment)); } \</div>
  214. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] std::align_val_t inAlignment) <span class="keyword">noexcept</span> { JPH::AlignedFree(inPointer); } \</div>
  215. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">size_t</span> inSize, [[maybe_unused]] std::align_val_t inAlignment) <span class="keyword">noexcept</span> { JPH::AlignedFree(inPointer); } \</div>
  216. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span>[] (<span class="keywordtype">size_t</span> inCount, std::align_val_t inAlignment) { <span class="keywordflow">return</span> JPH::AlignedAllocate(inCount, <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(inAlignment)); } \</div>
  217. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>[] (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] std::align_val_t inAlignment) <span class="keyword">noexcept</span> { JPH::AlignedFree(inPointer); } \</div>
  218. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>[] (<span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">size_t</span> inSize, [[maybe_unused]] std::align_val_t inAlignment) <span class="keyword">noexcept</span> { JPH::AlignedFree(inPointer); } \</div>
  219. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span> ([[maybe_unused]] <span class="keywordtype">size_t</span> inCount, <span class="keywordtype">void</span> *inPointer) <span class="keyword">noexcept</span> { <span class="keywordflow">return</span> inPointer; } \</div>
  220. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span> ([[maybe_unused]] <span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">void</span> *inPlace) <span class="keyword">noexcept</span> { <span class="comment">/* Do nothing */</span> } \</div>
  221. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> *<span class="keyword">operator</span> <span class="keyword">new</span>[] ([[maybe_unused]] <span class="keywordtype">size_t</span> inCount, <span class="keywordtype">void</span> *inPointer) <span class="keyword">noexcept</span> { <span class="keywordflow">return</span> inPointer; } \</div>
  222. <div class="line"> JPH_INLINE <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>[] ([[maybe_unused]] <span class="keywordtype">void</span> *inPointer, [[maybe_unused]] <span class="keywordtype">void</span> *inPlace) <span class="keyword">noexcept</span> { <span class="comment">/* Do nothing */</span> }</div>
  223. <div class="ttc" id="a_memory_8h_html_a59e48c2bba4ef31501a21fa76e2bd0ad"><div class="ttname"><a href="#a59e48c2bba4ef31501a21fa76e2bd0ad">JPH_INTERNAL_DEFAULT_FREE</a></div><div class="ttdeci">#define JPH_INTERNAL_DEFAULT_FREE(pointer)</div><div class="ttdef"><b>Definition</b> Memory.h:46</div></div>
  224. <div class="ttc" id="a_memory_8h_html_adf0d5d2601d9295abad305607595a7c9"><div class="ttname"><a href="#adf0d5d2601d9295abad305607595a7c9">JPH_INTERNAL_DEFAULT_ALLOCATE</a></div><div class="ttdeci">#define JPH_INTERNAL_DEFAULT_ALLOCATE(size)</div><div class="ttdef"><b>Definition</b> Memory.h:45</div></div>
  225. </div><!-- fragment -->
  226. <p>Macro to override the new and delete functions. </p>
  227. </div>
  228. </div>
  229. <h2 class="groupheader">Typedef Documentation</h2>
  230. <a id="a34745708a4f5ea89b7059f8f5952d3d6" name="a34745708a4f5ea89b7059f8f5952d3d6"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a34745708a4f5ea89b7059f8f5952d3d6">&#9670;&#160;</a></span>AlignedAllocateFunction</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">using <a class="el" href="#a34745708a4f5ea89b7059f8f5952d3d6">AlignedAllocateFunction</a> = void *(*)(size_t inSize, size_t inAlignment)</td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Aligned memory allocation. </p>
  241. </div>
  242. </div>
  243. <a id="ae5117b9da25ff2a21dfd5c159b36f1e1" name="ae5117b9da25ff2a21dfd5c159b36f1e1"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#ae5117b9da25ff2a21dfd5c159b36f1e1">&#9670;&#160;</a></span>AlignedFreeFunction</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">using <a class="el" href="#ae5117b9da25ff2a21dfd5c159b36f1e1">AlignedFreeFunction</a> = void (*)(void *inBlock)</td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Free aligned memory. inBlock can be nullptr in which case it must do nothing. </p>
  254. </div>
  255. </div>
  256. <a id="af18828908838938f4deb92fbde4b3015" name="af18828908838938f4deb92fbde4b3015"></a>
  257. <h2 class="memtitle"><span class="permalink"><a href="#af18828908838938f4deb92fbde4b3015">&#9670;&#160;</a></span>AllocateFunction</h2>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">using <a class="el" href="#af18828908838938f4deb92fbde4b3015">AllocateFunction</a> = void *(*)(size_t inSize)</td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Normal memory allocation, must be at least 8 byte aligned on 32 bit platform and 16 byte aligned on 64 bit platform. Note that you can override JPH_DEFAULT_ALLOCATE_ALIGNMENT if your allocator's alignment is different from the alignment as defined by <code>__STDCPP_DEFAULT_NEW_ALIGNMENT__</code>. </p>
  267. </div>
  268. </div>
  269. <a id="a57f7cd4691f45cd3537b6e8fd3705eb0" name="a57f7cd4691f45cd3537b6e8fd3705eb0"></a>
  270. <h2 class="memtitle"><span class="permalink"><a href="#a57f7cd4691f45cd3537b6e8fd3705eb0">&#9670;&#160;</a></span>FreeFunction</h2>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">using <a class="el" href="#a57f7cd4691f45cd3537b6e8fd3705eb0">FreeFunction</a> = void (*)(void *inBlock)</td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Free memory. inBlock can be nullptr in which case it must do nothing. </p>
  280. </div>
  281. </div>
  282. <a id="a173beb7a0579a0dc288c66cc87d693ff" name="a173beb7a0579a0dc288c66cc87d693ff"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#a173beb7a0579a0dc288c66cc87d693ff">&#9670;&#160;</a></span>ReallocateFunction</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">using <a class="el" href="#a173beb7a0579a0dc288c66cc87d693ff">ReallocateFunction</a> = void *(*)(void *inBlock, size_t inOldSize, size_t inNewSize)</td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>Reallocate memory. inBlock can be nullptr in which case it must behave as a memory allocation. </p>
  293. </div>
  294. </div>
  295. <h2 class="groupheader">Function Documentation</h2>
  296. <a id="a6ae804b1b68490f6e032ef6e7d9fc93e" name="a6ae804b1b68490f6e032ef6e7d9fc93e"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a6ae804b1b68490f6e032ef6e7d9fc93e">&#9670;&#160;</a></span>RegisterDefaultAllocator()</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void RegisterDefaultAllocator </td>
  303. <td>(</td>
  304. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Register platform default allocation / free functions. </p>
  310. </div>
  311. </div>
  312. <h2 class="groupheader">Variable Documentation</h2>
  313. <a id="a3aa09280dba8f254af17a487b8e407ff" name="a3aa09280dba8f254af17a487b8e407ff"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#a3aa09280dba8f254af17a487b8e407ff">&#9670;&#160;</a></span>AlignedAllocate</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a34745708a4f5ea89b7059f8f5952d3d6">AlignedAllocateFunction</a> AlignedAllocate</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. </div>
  332. </div>
  333. <a id="ade432661f00567a883e31a67e8d6dbb9" name="ade432661f00567a883e31a67e8d6dbb9"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#ade432661f00567a883e31a67e8d6dbb9">&#9670;&#160;</a></span>AlignedFree</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="mlabels">
  338. <tr>
  339. <td class="mlabels-left">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#ae5117b9da25ff2a21dfd5c159b36f1e1">AlignedFreeFunction</a> AlignedFree</td>
  343. </tr>
  344. </table>
  345. </td>
  346. <td class="mlabels-right">
  347. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. </div>
  352. </div>
  353. <a id="a8e44cb80cb8870970bc028513801205d" name="a8e44cb80cb8870970bc028513801205d"></a>
  354. <h2 class="memtitle"><span class="permalink"><a href="#a8e44cb80cb8870970bc028513801205d">&#9670;&#160;</a></span>Allocate</h2>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="mlabels">
  358. <tr>
  359. <td class="mlabels-left">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#af18828908838938f4deb92fbde4b3015">AllocateFunction</a> Allocate</td>
  363. </tr>
  364. </table>
  365. </td>
  366. <td class="mlabels-right">
  367. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. </div>
  372. </div>
  373. <a id="afff7dd3001cffbed9e362e4012b7f3af" name="afff7dd3001cffbed9e362e4012b7f3af"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#afff7dd3001cffbed9e362e4012b7f3af">&#9670;&#160;</a></span>Free</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"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a57f7cd4691f45cd3537b6e8fd3705eb0">FreeFunction</a> Free</td>
  383. </tr>
  384. </table>
  385. </td>
  386. <td class="mlabels-right">
  387. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. </div>
  392. </div>
  393. <a id="a8f705f8e1418d25f523b8aebf674322d" name="a8f705f8e1418d25f523b8aebf674322d"></a>
  394. <h2 class="memtitle"><span class="permalink"><a href="#a8f705f8e1418d25f523b8aebf674322d">&#9670;&#160;</a></span>Reallocate</h2>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="mlabels">
  398. <tr>
  399. <td class="mlabels-left">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="el" href="#a173beb7a0579a0dc288c66cc87d693ff">ReallocateFunction</a> Reallocate</td>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">extern</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. </div>
  412. </div>
  413. </div><!-- contents -->
  414. </div><!-- doc-content -->
  415. <!-- start footer part -->
  416. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  417. <ul>
  418. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_1b21a6f5692b6d84bf3b848a79181d46.html">Core</a></li><li class="navelem"><a class="el" href="_memory_8h.html">Memory.h</a></li>
  419. <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>
  420. </ul>
  421. </div>
  422. </body>
  423. </html>