_buffer_v_k_8h_source.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  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/Compute/VK/BufferVK.h Source File</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('_buffer_v_k_8h_source.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="headertitle"><div class="title">BufferVK.h</div></div>
  107. </div><!--header-->
  108. <div class="contents">
  109. <a href="_buffer_v_k_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
  110. <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2024 Jorrit Rouwe</span></div>
  111. <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
  112. <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
  113. <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
  114. <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
  115. <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="code" href="_include_v_k_8h.html">Jolt/Compute/VK/IncludeVK.h</a>&gt;</span></div>
  116. <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;<a class="code" href="_reference_8h.html">Jolt/Core/Reference.h</a>&gt;</span></div>
  117. <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
  118. <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
  119. <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
  120. <div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
  121. <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_memory_v_k.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="class_memory_v_k.html">MemoryVK</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_ref_target.html">RefTarget</a>&lt;MemoryVK&gt;</div>
  122. <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
  123. <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">public</span>:</div>
  124. <div class="foldopen" id="foldopen00016" data-start="{" data-end="}">
  125. <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#aaadfcc4e2a99e927f64bc70739259018"> 16</a></span> <a class="code hl_function" href="class_memory_v_k.html#aaadfcc4e2a99e927f64bc70739259018">~MemoryVK</a>()</div>
  126. <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
  127. <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// We should have unmapped and freed the block before destruction</span></div>
  128. <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_define" href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a>(<a class="code hl_variable" href="class_memory_v_k.html#a5762cea0dd907b004fb4da35723d8ec1">mMappedCount</a> == 0);</div>
  129. <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_define" href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a>(<a class="code hl_variable" href="class_memory_v_k.html#a5d0be8da74f8ab97d3259b8419b933b1">mMemory</a> == VK_NULL_HANDLE);</div>
  130. <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> }</div>
  131. </div>
  132. <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
  133. <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#a5d0be8da74f8ab97d3259b8419b933b1"> 23</a></span> VkDeviceMemory <a class="code hl_variable" href="class_memory_v_k.html#a5d0be8da74f8ab97d3259b8419b933b1">mMemory</a> = VK_NULL_HANDLE; </div>
  134. <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#acea4539b8f7abb5a4ddddf8cb79544ab"> 24</a></span> VkDeviceSize <a class="code hl_variable" href="class_memory_v_k.html#acea4539b8f7abb5a4ddddf8cb79544ab">mSize</a> = 0; </div>
  135. <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#a2c095a37e5ee32096cdeaac1d11d1a23"> 25</a></span> VkDeviceSize <a class="code hl_variable" href="class_memory_v_k.html#a2c095a37e5ee32096cdeaac1d11d1a23">mBufferSize</a> = 0; </div>
  136. <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#a8248d5051c5139fcf2572db441099609"> 26</a></span> VkMemoryPropertyFlags <a class="code hl_variable" href="class_memory_v_k.html#a8248d5051c5139fcf2572db441099609">mProperties</a> = 0; </div>
  137. <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#a5762cea0dd907b004fb4da35723d8ec1"> 27</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="class_memory_v_k.html#a5762cea0dd907b004fb4da35723d8ec1">mMappedCount</a> = 0; </div>
  138. <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_memory_v_k.html#af20c1626798c794da8facc194eac1b76"> 28</a></span> <span class="keywordtype">void</span> * <a class="code hl_variable" href="class_memory_v_k.html#af20c1626798c794da8facc194eac1b76">mMappedPtr</a> = <span class="keyword">nullptr</span>; </div>
  139. <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>};</div>
  140. </div>
  141. <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
  142. <div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
  143. <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="class_buffer_v_k.html"> 32</a></span><span class="keyword">class </span><a class="code hl_class" href="class_buffer_v_k.html">BufferVK</a></div>
  144. <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
  145. <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">public</span>:</div>
  146. <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_buffer_v_k.html#ad99c5dd9d0346363edb1a2e1586156b2"> 35</a></span> <a class="code hl_class" href="class_ref.html">Ref&lt;MemoryVK&gt;</a> <a class="code hl_variable" href="class_buffer_v_k.html#ad99c5dd9d0346363edb1a2e1586156b2">mMemory</a>; </div>
  147. <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_buffer_v_k.html#a133680d17b61a3e09a886873984fd014"> 36</a></span> VkBuffer <a class="code hl_variable" href="class_buffer_v_k.html#a133680d17b61a3e09a886873984fd014">mBuffer</a> = VK_NULL_HANDLE; </div>
  148. <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_buffer_v_k.html#a5f29d8ab2b35c01324acd63b46f147ea"> 37</a></span> VkDeviceSize <a class="code hl_variable" href="class_buffer_v_k.html#a5f29d8ab2b35c01324acd63b46f147ea">mOffset</a> = 0; </div>
  149. <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_buffer_v_k.html#adbd29752991df3e93e24dcb69d56ca04"> 38</a></span> VkDeviceSize <a class="code hl_variable" href="class_buffer_v_k.html#adbd29752991df3e93e24dcb69d56ca04">mSize</a> = 0; </div>
  150. <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>};</div>
  151. </div>
  152. <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
  153. <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
  154. <div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
  155. <div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
  156. <div class="ttc" id="a_include_v_k_8h_html"><div class="ttname"><a href="_include_v_k_8h.html">IncludeVK.h</a></div></div>
  157. <div class="ttc" id="a_issue_reporting_8h_html_aaf6b1df827e11b7ca5f6f8778bd8f8cd"><div class="ttname"><a href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a></div><div class="ttdeci">#define JPH_ASSERT(...)</div><div class="ttdef"><b>Definition</b> IssueReporting.h:33</div></div>
  158. <div class="ttc" id="a_reference_8h_html"><div class="ttname"><a href="_reference_8h.html">Reference.h</a></div></div>
  159. <div class="ttc" id="aclass_buffer_v_k_html"><div class="ttname"><a href="class_buffer_v_k.html">BufferVK</a></div><div class="ttdoc">Simple wrapper class to manage a Vulkan buffer.</div><div class="ttdef"><b>Definition</b> BufferVK.h:33</div></div>
  160. <div class="ttc" id="aclass_buffer_v_k_html_a133680d17b61a3e09a886873984fd014"><div class="ttname"><a href="class_buffer_v_k.html#a133680d17b61a3e09a886873984fd014">BufferVK::mBuffer</a></div><div class="ttdeci">VkBuffer mBuffer</div><div class="ttdoc">The Vulkan buffer handle.</div><div class="ttdef"><b>Definition</b> BufferVK.h:36</div></div>
  161. <div class="ttc" id="aclass_buffer_v_k_html_a5f29d8ab2b35c01324acd63b46f147ea"><div class="ttname"><a href="class_buffer_v_k.html#a5f29d8ab2b35c01324acd63b46f147ea">BufferVK::mOffset</a></div><div class="ttdeci">VkDeviceSize mOffset</div><div class="ttdoc">Offset in the memory block where the buffer starts.</div><div class="ttdef"><b>Definition</b> BufferVK.h:37</div></div>
  162. <div class="ttc" id="aclass_buffer_v_k_html_ad99c5dd9d0346363edb1a2e1586156b2"><div class="ttname"><a href="class_buffer_v_k.html#ad99c5dd9d0346363edb1a2e1586156b2">BufferVK::mMemory</a></div><div class="ttdeci">Ref&lt; MemoryVK &gt; mMemory</div><div class="ttdoc">The memory block that contains the buffer (note that filling this in is optional if you do your own b...</div><div class="ttdef"><b>Definition</b> BufferVK.h:35</div></div>
  163. <div class="ttc" id="aclass_buffer_v_k_html_adbd29752991df3e93e24dcb69d56ca04"><div class="ttname"><a href="class_buffer_v_k.html#adbd29752991df3e93e24dcb69d56ca04">BufferVK::mSize</a></div><div class="ttdeci">VkDeviceSize mSize</div><div class="ttdoc">Real size of the buffer.</div><div class="ttdef"><b>Definition</b> BufferVK.h:38</div></div>
  164. <div class="ttc" id="aclass_memory_v_k_html"><div class="ttname"><a href="class_memory_v_k.html">MemoryVK</a></div><div class="ttdoc">Simple wrapper class to manage a Vulkan memory block.</div><div class="ttdef"><b>Definition</b> BufferVK.h:14</div></div>
  165. <div class="ttc" id="aclass_memory_v_k_html_a2c095a37e5ee32096cdeaac1d11d1a23"><div class="ttname"><a href="class_memory_v_k.html#a2c095a37e5ee32096cdeaac1d11d1a23">MemoryVK::mBufferSize</a></div><div class="ttdeci">VkDeviceSize mBufferSize</div><div class="ttdoc">Size of each of the buffers that this memory block has been divided into.</div><div class="ttdef"><b>Definition</b> BufferVK.h:25</div></div>
  166. <div class="ttc" id="aclass_memory_v_k_html_a5762cea0dd907b004fb4da35723d8ec1"><div class="ttname"><a href="class_memory_v_k.html#a5762cea0dd907b004fb4da35723d8ec1">MemoryVK::mMappedCount</a></div><div class="ttdeci">int mMappedCount</div><div class="ttdoc">How often buffers using this memory block were mapped.</div><div class="ttdef"><b>Definition</b> BufferVK.h:27</div></div>
  167. <div class="ttc" id="aclass_memory_v_k_html_a5d0be8da74f8ab97d3259b8419b933b1"><div class="ttname"><a href="class_memory_v_k.html#a5d0be8da74f8ab97d3259b8419b933b1">MemoryVK::mMemory</a></div><div class="ttdeci">VkDeviceMemory mMemory</div><div class="ttdoc">The Vulkan memory handle.</div><div class="ttdef"><b>Definition</b> BufferVK.h:23</div></div>
  168. <div class="ttc" id="aclass_memory_v_k_html_a8248d5051c5139fcf2572db441099609"><div class="ttname"><a href="class_memory_v_k.html#a8248d5051c5139fcf2572db441099609">MemoryVK::mProperties</a></div><div class="ttdeci">VkMemoryPropertyFlags mProperties</div><div class="ttdoc">Vulkan memory properties used to allocate this block.</div><div class="ttdef"><b>Definition</b> BufferVK.h:26</div></div>
  169. <div class="ttc" id="aclass_memory_v_k_html_aaadfcc4e2a99e927f64bc70739259018"><div class="ttname"><a href="class_memory_v_k.html#aaadfcc4e2a99e927f64bc70739259018">MemoryVK::~MemoryVK</a></div><div class="ttdeci">~MemoryVK()</div><div class="ttdef"><b>Definition</b> BufferVK.h:16</div></div>
  170. <div class="ttc" id="aclass_memory_v_k_html_acea4539b8f7abb5a4ddddf8cb79544ab"><div class="ttname"><a href="class_memory_v_k.html#acea4539b8f7abb5a4ddddf8cb79544ab">MemoryVK::mSize</a></div><div class="ttdeci">VkDeviceSize mSize</div><div class="ttdoc">Size of the memory block.</div><div class="ttdef"><b>Definition</b> BufferVK.h:24</div></div>
  171. <div class="ttc" id="aclass_memory_v_k_html_af20c1626798c794da8facc194eac1b76"><div class="ttname"><a href="class_memory_v_k.html#af20c1626798c794da8facc194eac1b76">MemoryVK::mMappedPtr</a></div><div class="ttdeci">void * mMappedPtr</div><div class="ttdoc">The CPU address of the memory block when mapped.</div><div class="ttdef"><b>Definition</b> BufferVK.h:28</div></div>
  172. <div class="ttc" id="aclass_ref_html"><div class="ttname"><a href="class_ref.html">Ref</a></div><div class="ttdef"><b>Definition</b> Reference.h:107</div></div>
  173. <div class="ttc" id="aclass_ref_target_html"><div class="ttname"><a href="class_ref_target.html">RefTarget</a></div><div class="ttdef"><b>Definition</b> Reference.h:35</div></div>
  174. </div><!-- fragment --></div><!-- contents -->
  175. </div><!-- doc-content -->
  176. <!-- start footer part -->
  177. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  178. <ul>
  179. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_64944cfb4dfe78995d2e5c57bfdada37.html">Compute</a></li><li class="navelem"><a class="el" href="dir_1acac186c3cf0356defe4b6fa1afcde3.html">VK</a></li><li class="navelem"><a class="el" href="_buffer_v_k_8h.html">BufferVK.h</a></li>
  180. <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>
  181. </ul>
  182. </div>
  183. </body>
  184. </html>