class_temp_allocator_impl.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446
  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: TempAllocatorImpl Class 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('class_temp_allocator_impl.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="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="class_temp_allocator_impl-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">TempAllocatorImpl Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Default implementation of the temp allocator that allocates a large block through malloc upfront.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_temp_allocator_8h_source.html">TempAllocator.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for TempAllocatorImpl:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_temp_allocator_impl.png" usemap="#TempAllocatorImpl_map" alt=""/>
  120. <map id="TempAllocatorImpl_map" name="TempAllocatorImpl_map">
  121. <area href="class_temp_allocator.html" alt="TempAllocator" shape="rect" coords="0,56,115,80"/>
  122. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,115,24"/>
  123. </map>
  124. </div></div>
  125. <table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:a874338fcacbdb3af3596335afb94c263" id="r_a874338fcacbdb3af3596335afb94c263"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a874338fcacbdb3af3596335afb94c263">TempAllocatorImpl</a> (size_t inSize)</td></tr>
  129. <tr class="memdesc:a874338fcacbdb3af3596335afb94c263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the allocator with a maximum allocatable size of inSize. <br /></td></tr>
  130. <tr class="separator:a874338fcacbdb3af3596335afb94c263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a7ced1650e61db4a4917ac8eb2e1cbe30" id="r_a7ced1650e61db4a4917ac8eb2e1cbe30"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ced1650e61db4a4917ac8eb2e1cbe30">~TempAllocatorImpl</a> () override</td></tr>
  132. <tr class="memdesc:a7ced1650e61db4a4917ac8eb2e1cbe30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor, frees the block. <br /></td></tr>
  133. <tr class="separator:a7ced1650e61db4a4917ac8eb2e1cbe30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:adf9ef85969afed92a4fb14b1e6ff1ac5" id="r_adf9ef85969afed92a4fb14b1e6ff1ac5"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf9ef85969afed92a4fb14b1e6ff1ac5">Allocate</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSize) override</td></tr>
  135. <tr class="memdesc:adf9ef85969afed92a4fb14b1e6ff1ac5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates inSize bytes of memory, returned memory address must be JPH_RVECTOR_ALIGNMENT byte aligned. <br /></td></tr>
  136. <tr class="separator:adf9ef85969afed92a4fb14b1e6ff1ac5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aa7b2ea67b67c57c776d4c2a415b430ba" id="r_aa7b2ea67b67c57c776d4c2a415b430ba"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7b2ea67b67c57c776d4c2a415b430ba">Free</a> (void *inAddress, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSize) override</td></tr>
  138. <tr class="memdesc:aa7b2ea67b67c57c776d4c2a415b430ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees inSize bytes of memory located at inAddress. <br /></td></tr>
  139. <tr class="separator:aa7b2ea67b67c57c776d4c2a415b430ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ac998e260e54f25b3493d30e24b15bef2" id="r_ac998e260e54f25b3493d30e24b15bef2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac998e260e54f25b3493d30e24b15bef2">IsEmpty</a> () const</td></tr>
  141. <tr class="memdesc:ac998e260e54f25b3493d30e24b15bef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if no allocations have been made. <br /></td></tr>
  142. <tr class="separator:ac998e260e54f25b3493d30e24b15bef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a56356a3176389ddd4b278e268f7a6b7f" id="r_a56356a3176389ddd4b278e268f7a6b7f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56356a3176389ddd4b278e268f7a6b7f">GetSize</a> () const</td></tr>
  144. <tr class="memdesc:a56356a3176389ddd4b278e268f7a6b7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the total size of the fixed buffer. <br /></td></tr>
  145. <tr class="separator:a56356a3176389ddd4b278e268f7a6b7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a51303fe4dfc64985675b9537ef2f8edb" id="r_a51303fe4dfc64985675b9537ef2f8edb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51303fe4dfc64985675b9537ef2f8edb">GetUsage</a> () const</td></tr>
  147. <tr class="memdesc:a51303fe4dfc64985675b9537ef2f8edb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current usage in bytes of the buffer. <br /></td></tr>
  148. <tr class="separator:a51303fe4dfc64985675b9537ef2f8edb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ac698ca89fe759ecd74899cd93d4028a6" id="r_ac698ca89fe759ecd74899cd93d4028a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac698ca89fe759ecd74899cd93d4028a6">CanAllocate</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSize) const</td></tr>
  150. <tr class="memdesc:ac698ca89fe759ecd74899cd93d4028a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if an allocation of inSize can be made in this fixed buffer allocator. <br /></td></tr>
  151. <tr class="separator:ac698ca89fe759ecd74899cd93d4028a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a5d90cdbf402b46a9429593da08008bdc" id="r_a5d90cdbf402b46a9429593da08008bdc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d90cdbf402b46a9429593da08008bdc">OwnsMemory</a> (const void *inAddress) const</td></tr>
  153. <tr class="memdesc:a5d90cdbf402b46a9429593da08008bdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if memory block at inAddress is owned by this allocator. <br /></td></tr>
  154. <tr class="separator:a5d90cdbf402b46a9429593da08008bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="inherit_header pub_methods_class_temp_allocator"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_temp_allocator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_temp_allocator.html">TempAllocator</a></td></tr>
  156. <tr class="memitem:ab44895b2fff0b5814a3903b5cae60912 inherit pub_methods_class_temp_allocator" id="r_ab44895b2fff0b5814a3903b5cae60912"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temp_allocator.html#ab44895b2fff0b5814a3903b5cae60912">~TempAllocator</a> ()=default</td></tr>
  157. <tr class="memdesc:ab44895b2fff0b5814a3903b5cae60912 inherit pub_methods_class_temp_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  158. <tr class="separator:ab44895b2fff0b5814a3903b5cae60912 inherit pub_methods_class_temp_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
  160. <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
  161. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  163. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  165. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table><table class="memberdecls">
  167. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  168. Additional Inherited Members</h2></td></tr>
  169. <tr class="inherit_header pub_static_attribs_class_temp_allocator"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_attribs_class_temp_allocator')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_temp_allocator.html">TempAllocator</a></td></tr>
  170. <tr class="memitem:a6a58502ba1dcf02113fda640acf49fd9 inherit pub_static_attribs_class_temp_allocator" id="r_a6a58502ba1dcf02113fda640acf49fd9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temp_allocator.html#a6a58502ba1dcf02113fda640acf49fd9">needs_aligned_allocate</a> = <a class="el" href="_real_8h.html#ac6a49178acb5c5ecdbab2424aca0e474">JPH_RVECTOR_ALIGNMENT</a> &gt; <a class="el" href="_core_8h.html#a25f22c6e1ee09e17aef6d6c1e9e6ce63">JPH_DEFAULT_ALLOCATE_ALIGNMENT</a></td></tr>
  171. <tr class="memdesc:a6a58502ba1dcf02113fda640acf49fd9 inherit pub_static_attribs_class_temp_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this allocator needs to fall back to aligned allocations because JPH_RVECTOR_ALIGNMENT is bigger than the platform default. <br /></td></tr>
  172. <tr class="separator:a6a58502ba1dcf02113fda640acf49fd9 inherit pub_static_attribs_class_temp_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table>
  174. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  175. <div class="textblock"><p>Default implementation of the temp allocator that allocates a large block through malloc upfront. </p>
  176. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  177. <a id="a874338fcacbdb3af3596335afb94c263" name="a874338fcacbdb3af3596335afb94c263"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#a874338fcacbdb3af3596335afb94c263">&#9670;&#160;</a></span>TempAllocatorImpl()</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="mlabels">
  182. <tr>
  183. <td class="mlabels-left">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> TempAllocatorImpl::TempAllocatorImpl </td>
  187. <td>(</td>
  188. <td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>inSize</em></span></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </td>
  193. <td class="mlabels-right">
  194. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>Constructs the allocator with a maximum allocatable size of inSize. </p>
  199. </div>
  200. </div>
  201. <a id="a7ced1650e61db4a4917ac8eb2e1cbe30" name="a7ced1650e61db4a4917ac8eb2e1cbe30"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a7ced1650e61db4a4917ac8eb2e1cbe30">&#9670;&#160;</a></span>~TempAllocatorImpl()</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="mlabels">
  206. <tr>
  207. <td class="mlabels-left">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">virtual TempAllocatorImpl::~TempAllocatorImpl </td>
  211. <td>(</td>
  212. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  213. <td></td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Destructor, frees the block. </p>
  223. </div>
  224. </div>
  225. <h2 class="groupheader">Member Function Documentation</h2>
  226. <a id="adf9ef85969afed92a4fb14b1e6ff1ac5" name="adf9ef85969afed92a4fb14b1e6ff1ac5"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#adf9ef85969afed92a4fb14b1e6ff1ac5">&#9670;&#160;</a></span>Allocate()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="mlabels">
  231. <tr>
  232. <td class="mlabels-left">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">virtual void * TempAllocatorImpl::Allocate </td>
  236. <td>(</td>
  237. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inSize</em></span></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Allocates inSize bytes of memory, returned memory address must be JPH_RVECTOR_ALIGNMENT byte aligned. </p>
  248. <p>Implements <a class="el" href="class_temp_allocator.html#aa62f890910ee965efea7244953f3c65e">TempAllocator</a>.</p>
  249. </div>
  250. </div>
  251. <a id="ac698ca89fe759ecd74899cd93d4028a6" name="ac698ca89fe759ecd74899cd93d4028a6"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#ac698ca89fe759ecd74899cd93d4028a6">&#9670;&#160;</a></span>CanAllocate()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">bool TempAllocatorImpl::CanAllocate </td>
  261. <td>(</td>
  262. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inSize</em></span></td><td>)</td>
  263. <td> const</td>
  264. </tr>
  265. </table>
  266. </td>
  267. <td class="mlabels-right">
  268. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Check if an allocation of inSize can be made in this fixed buffer allocator. </p>
  273. </div>
  274. </div>
  275. <a id="aa7b2ea67b67c57c776d4c2a415b430ba" name="aa7b2ea67b67c57c776d4c2a415b430ba"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#aa7b2ea67b67c57c776d4c2a415b430ba">&#9670;&#160;</a></span>Free()</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">virtual void TempAllocatorImpl::Free </td>
  285. <td>(</td>
  286. <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>inAddress</em></span>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inSize</em></span>&#160;)</td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Frees inSize bytes of memory located at inAddress. </p>
  301. <p>Implements <a class="el" href="class_temp_allocator.html#a1d9399cbf93c253a7f03d8ffea249bfe">TempAllocator</a>.</p>
  302. </div>
  303. </div>
  304. <a id="a56356a3176389ddd4b278e268f7a6b7f" name="a56356a3176389ddd4b278e268f7a6b7f"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a56356a3176389ddd4b278e268f7a6b7f">&#9670;&#160;</a></span>GetSize()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="mlabels">
  309. <tr>
  310. <td class="mlabels-left">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">size_t TempAllocatorImpl::GetSize </td>
  314. <td>(</td>
  315. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  316. <td> const</td>
  317. </tr>
  318. </table>
  319. </td>
  320. <td class="mlabels-right">
  321. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Get the total size of the fixed buffer. </p>
  326. </div>
  327. </div>
  328. <a id="a51303fe4dfc64985675b9537ef2f8edb" name="a51303fe4dfc64985675b9537ef2f8edb"></a>
  329. <h2 class="memtitle"><span class="permalink"><a href="#a51303fe4dfc64985675b9537ef2f8edb">&#9670;&#160;</a></span>GetUsage()</h2>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="mlabels">
  333. <tr>
  334. <td class="mlabels-left">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">size_t TempAllocatorImpl::GetUsage </td>
  338. <td>(</td>
  339. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  340. <td> const</td>
  341. </tr>
  342. </table>
  343. </td>
  344. <td class="mlabels-right">
  345. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. <p>Get current usage in bytes of the buffer. </p>
  350. </div>
  351. </div>
  352. <a id="ac998e260e54f25b3493d30e24b15bef2" name="ac998e260e54f25b3493d30e24b15bef2"></a>
  353. <h2 class="memtitle"><span class="permalink"><a href="#ac998e260e54f25b3493d30e24b15bef2">&#9670;&#160;</a></span>IsEmpty()</h2>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="mlabels">
  357. <tr>
  358. <td class="mlabels-left">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">bool TempAllocatorImpl::IsEmpty </td>
  362. <td>(</td>
  363. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  364. <td> const</td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Check if no allocations have been made. </p>
  374. </div>
  375. </div>
  376. <a id="a5d90cdbf402b46a9429593da08008bdc" name="a5d90cdbf402b46a9429593da08008bdc"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#a5d90cdbf402b46a9429593da08008bdc">&#9670;&#160;</a></span>OwnsMemory()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="mlabels">
  381. <tr>
  382. <td class="mlabels-left">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">bool TempAllocatorImpl::OwnsMemory </td>
  386. <td>(</td>
  387. <td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>inAddress</em></span></td><td>)</td>
  388. <td> const</td>
  389. </tr>
  390. </table>
  391. </td>
  392. <td class="mlabels-right">
  393. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Check if memory block at inAddress is owned by this allocator. </p>
  398. </div>
  399. </div>
  400. <hr/>The documentation for this class was generated from the following file:<ul>
  401. <li>Jolt/Core/<a class="el" href="_temp_allocator_8h_source.html">TempAllocator.h</a></li>
  402. </ul>
  403. </div><!-- contents -->
  404. </div><!-- doc-content -->
  405. <!-- start footer part -->
  406. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  407. <ul>
  408. <li class="navelem"><a class="el" href="class_temp_allocator_impl.html">TempAllocatorImpl</a></li>
  409. <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>
  410. </ul>
  411. </div>
  412. </body>
  413. </html>