class_compute_system.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  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: ComputeSystem 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_compute_system.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-types">Public Types</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pub-attribs">Public Attributes</a> &#124;
  110. <a href="class_compute_system-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">ComputeSystem Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Interface to run a workload on the GPU.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_compute_system_8h_source.html">ComputeSystem.h</a>&gt;</code></p>
  117. <div class="dynheader">
  118. Inheritance diagram for ComputeSystem:</div>
  119. <div class="dyncontent">
  120. <div class="center">
  121. <img src="class_compute_system.png" usemap="#ComputeSystem_map" alt=""/>
  122. <map id="ComputeSystem_map" name="ComputeSystem_map">
  123. <area href="class_ref_target.html" alt="RefTarget&lt; ComputeSystem &gt;" shape="rect" coords="0,0,180,24"/>
  124. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="190,0,370,24"/>
  125. </map>
  126. </div></div>
  127. <table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  129. Public Types</h2></td></tr>
  130. <tr class="memitem:a943a0e5f368f43f69a89ca9305b34395" id="r_a943a0e5f368f43f69a89ca9305b34395"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a943a0e5f368f43f69a89ca9305b34395">ShaderLoader</a> = std::function&lt;bool(const char *inName, <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&gt; &amp;outData)&gt;</td></tr>
  131. <tr class="memdesc:a943a0e5f368f43f69a89ca9305b34395"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback used when loading shaders. <br /></td></tr>
  132. <tr class="separator:a943a0e5f368f43f69a89ca9305b34395"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  135. Public Member Functions</h2></td></tr>
  136. <tr class="memitem:aa250ab6060bae9edc8de92a1a5f144ef" id="r_aa250ab6060bae9edc8de92a1a5f144ef"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa250ab6060bae9edc8de92a1a5f144ef">~ComputeSystem</a> ()=default</td></tr>
  137. <tr class="memdesc:aa250ab6060bae9edc8de92a1a5f144ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  138. <tr class="separator:aa250ab6060bae9edc8de92a1a5f144ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a3d6b9f7d2f61c9a0f78d42b1cb9e50a1" id="r_a3d6b9f7d2f61c9a0f78d42b1cb9e50a1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_shader.html">ComputeShader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d6b9f7d2f61c9a0f78d42b1cb9e50a1">CreateComputeShader</a> (const char *inName, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inGroupSizeX, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inGroupSizeY=1, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inGroupSizeZ=1)=0</td></tr>
  140. <tr class="memdesc:a3d6b9f7d2f61c9a0f78d42b1cb9e50a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile a compute shader. <br /></td></tr>
  141. <tr class="separator:a3d6b9f7d2f61c9a0f78d42b1cb9e50a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a7c4b94452e72788c150b89996747f6a1" id="r_a7c4b94452e72788c150b89996747f6a1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c4b94452e72788c150b89996747f6a1">CreateComputeBuffer</a> (<a class="el" href="class_compute_buffer.html#ac1a2f4a6e9eff820908ca3386d478c6a">ComputeBuffer::EType</a> inType, <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inSize, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inStride, const void *inData=nullptr)=0</td></tr>
  143. <tr class="memdesc:a7c4b94452e72788c150b89996747f6a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a buffer for use with a compute shader. <br /></td></tr>
  144. <tr class="separator:a7c4b94452e72788c150b89996747f6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a7583d3bff974b44a3c3cf9247ff6b913" id="r_a7583d3bff974b44a3c3cf9247ff6b913"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_queue.html">ComputeQueue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7583d3bff974b44a3c3cf9247ff6b913">CreateComputeQueue</a> ()=0</td></tr>
  146. <tr class="memdesc:a7583d3bff974b44a3c3cf9247ff6b913"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a queue for executing compute shaders. <br /></td></tr>
  147. <tr class="separator:a7583d3bff974b44a3c3cf9247ff6b913"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeSystem &gt;</a></td></tr>
  149. <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
  150. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  151. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  153. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
  155. <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
  156. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
  158. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  160. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  161. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><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="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
  163. <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
  164. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
  166. <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
  167. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
  169. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <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>
  171. <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>
  172. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <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>
  174. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <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>
  176. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. </table><table class="memberdecls">
  178. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  179. Public Attributes</h2></td></tr>
  180. <tr class="memitem:a839e84805dc71226cb0a086947559985" id="r_a839e84805dc71226cb0a086947559985"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a943a0e5f368f43f69a89ca9305b34395">ShaderLoader</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a839e84805dc71226cb0a086947559985">mShaderLoader</a> = [](const char *, <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&gt; &amp;) { <a class="el" href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a>(false, &quot;Override this function&quot;); return false; }</td></tr>
  181. <tr class="separator:a839e84805dc71226cb0a086947559985"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. </table><table class="memberdecls">
  183. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  184. Additional Inherited Members</h2></td></tr>
  185. <tr class="inherit_header pub_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeSystem &gt;</a></td></tr>
  186. <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
  187. <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
  188. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeSystem &gt;</a></td></tr>
  190. <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic&lt; <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
  191. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  192. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeSystem &gt;</a></td></tr>
  194. <tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
  195. <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
  196. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. </table>
  198. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  199. <div class="textblock"><p>Interface to run a workload on the GPU. </p>
  200. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  201. <a id="a943a0e5f368f43f69a89ca9305b34395" name="a943a0e5f368f43f69a89ca9305b34395"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a943a0e5f368f43f69a89ca9305b34395">&#9670;&#160;</a></span>ShaderLoader</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">using <a class="el" href="#a943a0e5f368f43f69a89ca9305b34395">ComputeSystem::ShaderLoader</a> = std::function&lt;bool(const char *inName, <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&gt; &amp;outData)&gt;</td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Callback used when loading shaders. </p>
  212. </div>
  213. </div>
  214. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  215. <a id="aa250ab6060bae9edc8de92a1a5f144ef" name="aa250ab6060bae9edc8de92a1a5f144ef"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#aa250ab6060bae9edc8de92a1a5f144ef">&#9670;&#160;</a></span>~ComputeSystem()</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> ComputeSystem::~ComputeSystem </td>
  225. <td>(</td>
  226. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  227. <td></td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Destructor. </p>
  237. </div>
  238. </div>
  239. <h2 class="groupheader">Member Function Documentation</h2>
  240. <a id="a7c4b94452e72788c150b89996747f6a1" name="a7c4b94452e72788c150b89996747f6a1"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#a7c4b94452e72788c150b89996747f6a1">&#9670;&#160;</a></span>CreateComputeBuffer()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> &gt; ComputeSystem::CreateComputeBuffer </td>
  250. <td>(</td>
  251. <td class="paramtype"><a class="el" href="class_compute_buffer.html#ac1a2f4a6e9eff820908ca3386d478c6a">ComputeBuffer::EType</a></td> <td class="paramname"><span class="paramname"><em>inType</em></span>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inSize</em></span>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inStride</em></span>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>inData</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>&#160;)</td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>Create a buffer for use with a compute shader. </p>
  276. </div>
  277. </div>
  278. <a id="a7583d3bff974b44a3c3cf9247ff6b913" name="a7583d3bff974b44a3c3cf9247ff6b913"></a>
  279. <h2 class="memtitle"><span class="permalink"><a href="#a7583d3bff974b44a3c3cf9247ff6b913">&#9670;&#160;</a></span>CreateComputeQueue()</h2>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_queue.html">ComputeQueue</a> &gt; ComputeSystem::CreateComputeQueue </td>
  288. <td>(</td>
  289. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Create a queue for executing compute shaders. </p>
  300. </div>
  301. </div>
  302. <a id="a3d6b9f7d2f61c9a0f78d42b1cb9e50a1" name="a3d6b9f7d2f61c9a0f78d42b1cb9e50a1"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#a3d6b9f7d2f61c9a0f78d42b1cb9e50a1">&#9670;&#160;</a></span>CreateComputeShader()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">virtual <a class="el" href="class_ref.html">Ref</a>&lt; <a class="el" href="class_compute_shader.html">ComputeShader</a> &gt; ComputeSystem::CreateComputeShader </td>
  312. <td>(</td>
  313. <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inGroupSizeX</em></span>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inGroupSizeY</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>, </td>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inGroupSizeZ</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>&#160;)</td>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>Compile a compute shader. </p>
  338. </div>
  339. </div>
  340. <h2 class="groupheader">Member Data Documentation</h2>
  341. <a id="a839e84805dc71226cb0a086947559985" name="a839e84805dc71226cb0a086947559985"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a839e84805dc71226cb0a086947559985">&#9670;&#160;</a></span>mShaderLoader</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname"><a class="el" href="#a943a0e5f368f43f69a89ca9305b34395">ShaderLoader</a> ComputeSystem::mShaderLoader = [](const char *, <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&gt; &amp;) { <a class="el" href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a>(false, &quot;Override this function&quot;); return false; }</td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. </div>
  352. </div>
  353. <hr/>The documentation for this class was generated from the following file:<ul>
  354. <li>Jolt/Compute/<a class="el" href="_compute_system_8h_source.html">ComputeSystem.h</a></li>
  355. </ul>
  356. </div><!-- contents -->
  357. </div><!-- doc-content -->
  358. <!-- start footer part -->
  359. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  360. <ul>
  361. <li class="navelem"><a class="el" href="class_compute_system.html">ComputeSystem</a></li>
  362. <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>
  363. </ul>
  364. </div>
  365. </body>
  366. </html>