| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.12.0"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Jolt Physics: ComputeQueueCPU Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_compute_queue_c_p_u.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_compute_queue_c_p_u-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ComputeQueueCPU Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
- </div><!--header-->
- <div class="contents">
- <p>A command queue for the CPU compute system.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_compute_queue_c_p_u_8h_source.html">ComputeQueueCPU.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for ComputeQueueCPU:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_compute_queue_c_p_u.png" usemap="#ComputeQueueCPU_map" alt=""/>
- <map id="ComputeQueueCPU_map" name="ComputeQueueCPU_map">
- <area href="class_compute_queue.html" alt="ComputeQueue" shape="rect" coords="94,56,272,80"/>
- <area href="class_ref_target.html" alt="RefTarget< ComputeQueue >" shape="rect" coords="0,0,178,24"/>
- <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="188,0,366,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:ac739504699750645cc3a33ba5d45dbac" id="r_ac739504699750645cc3a33ba5d45dbac"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac739504699750645cc3a33ba5d45dbac">~ComputeQueueCPU</a> () override</td></tr>
- <tr class="memdesc:ac739504699750645cc3a33ba5d45dbac"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:ac739504699750645cc3a33ba5d45dbac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae6feb8658c2df5ad3db52aca4d75c067" id="r_ae6feb8658c2df5ad3db52aca4d75c067"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6feb8658c2df5ad3db52aca4d75c067">SetShader</a> (const <a class="el" href="class_compute_shader.html">ComputeShader</a> *inShader) override</td></tr>
- <tr class="separator:ae6feb8658c2df5ad3db52aca4d75c067"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1a1fc266c9f9100892113f6e8e9de63d" id="r_a1a1fc266c9f9100892113f6e8e9de63d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a1fc266c9f9100892113f6e8e9de63d">SetConstantBuffer</a> (const char *inName, const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer) override</td></tr>
- <tr class="separator:a1a1fc266c9f9100892113f6e8e9de63d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a56704247ac47e70040c48a7266d289f2" id="r_a56704247ac47e70040c48a7266d289f2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a56704247ac47e70040c48a7266d289f2">SetBuffer</a> (const char *inName, const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer) override</td></tr>
- <tr class="separator:a56704247ac47e70040c48a7266d289f2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad48fbd0850250e43a4b3c04c3ba882a7" id="r_ad48fbd0850250e43a4b3c04c3ba882a7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad48fbd0850250e43a4b3c04c3ba882a7">SetRWBuffer</a> (const char *inName, <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer, <a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257">EBarrier</a> inBarrier=<a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">EBarrier::Yes</a>) override</td></tr>
- <tr class="separator:ad48fbd0850250e43a4b3c04c3ba882a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aebd08c87361fd17f88d06ddcdbdd9154" id="r_aebd08c87361fd17f88d06ddcdbdd9154"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebd08c87361fd17f88d06ddcdbdd9154">ScheduleReadback</a> (<a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inDst, const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inSrc) override</td></tr>
- <tr class="separator:aebd08c87361fd17f88d06ddcdbdd9154"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a958fb9f8bcc505ee9194af7294f617be" id="r_a958fb9f8bcc505ee9194af7294f617be"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a958fb9f8bcc505ee9194af7294f617be">Dispatch</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsX, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsY, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsZ) override</td></tr>
- <tr class="memdesc:a958fb9f8bcc505ee9194af7294f617be"><td class="mdescLeft"> </td><td class="mdescRight">Dispatch a compute shader with the specified number of thread groups. <br /></td></tr>
- <tr class="separator:a958fb9f8bcc505ee9194af7294f617be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a73ac279311593a75fe528e34b613330e" id="r_a73ac279311593a75fe528e34b613330e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a73ac279311593a75fe528e34b613330e">Execute</a> () override</td></tr>
- <tr class="separator:a73ac279311593a75fe528e34b613330e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5bd33aec36575483ad95fb73c7d2583b" id="r_a5bd33aec36575483ad95fb73c7d2583b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5bd33aec36575483ad95fb73c7d2583b">Wait</a> () override</td></tr>
- <tr class="separator:a5bd33aec36575483ad95fb73c7d2583b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_compute_queue"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_compute_queue')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_compute_queue.html">ComputeQueue</a></td></tr>
- <tr class="memitem:ad1e2dc9b2bc00f02087e8317921ee806 inherit pub_methods_class_compute_queue" id="r_ad1e2dc9b2bc00f02087e8317921ee806"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_queue.html#ad1e2dc9b2bc00f02087e8317921ee806">~ComputeQueue</a> ()=default</td></tr>
- <tr class="memdesc:ad1e2dc9b2bc00f02087e8317921ee806 inherit pub_methods_class_compute_queue"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:ad1e2dc9b2bc00f02087e8317921ee806 inherit pub_methods_class_compute_queue"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc3e87cf4f95f62c8ee51cf3ee3b2a1e inherit pub_methods_class_compute_queue" id="r_acc3e87cf4f95f62c8ee51cf3ee3b2a1e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_queue.html#acc3e87cf4f95f62c8ee51cf3ee3b2a1e">ExecuteAndWait</a> ()</td></tr>
- <tr class="separator:acc3e87cf4f95f62c8ee51cf3ee3b2a1e inherit pub_methods_class_compute_queue"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< ComputeQueue ></a></td></tr>
- <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
- <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top"> </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> &)</td></tr>
- <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
- <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
- <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
- <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <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> & </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> &)</td></tr>
- <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
- <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
- <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
- <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
- <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
- <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
- <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
- <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
- <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
- <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void </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> &)=delete</td></tr>
- <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_types_class_compute_queue"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_compute_queue')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_compute_queue.html">ComputeQueue</a></td></tr>
- <tr class="memitem:a1309e3ae62b5f5817e1094e872c2a257 inherit pub_types_class_compute_queue" id="r_a1309e3ae62b5f5817e1094e872c2a257"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257">EBarrier</a> { <a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">Yes</a>
- , <a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257abafd7322c6e97d25b6299b5d6fe8920b">No</a>
- }</td></tr>
- <tr class="memdesc:a1309e3ae62b5f5817e1094e872c2a257"><td class="mdescLeft"> </td><td class="mdescRight">If a barrier should be placed before accessing the buffer. <a href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257">More...</a><br /></td></tr>
- <tr class="separator:a1309e3ae62b5f5817e1094e872c2a257 inherit pub_types_class_compute_queue"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< ComputeQueue ></a></td></tr>
- <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
- <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
- <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< ComputeQueue ></a></td></tr>
- <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic< <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
- <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Current reference count. <br /></td></tr>
- <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< ComputeQueue ></a></td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
- <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
- <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>A command queue for the CPU compute system. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="ac739504699750645cc3a33ba5d45dbac" name="ac739504699750645cc3a33ba5d45dbac"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac739504699750645cc3a33ba5d45dbac">◆ </a></span>~ComputeQueueCPU()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> ComputeQueueCPU::~ComputeQueueCPU </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a958fb9f8bcc505ee9194af7294f617be" name="a958fb9f8bcc505ee9194af7294f617be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a958fb9f8bcc505ee9194af7294f617be">◆ </a></span>Dispatch()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::Dispatch </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inThreadGroupsX</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inThreadGroupsY</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inThreadGroupsZ</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Dispatch a compute shader with the specified number of thread groups. </p>
- <p>Implements <a class="el" href="class_compute_queue.html#abdca367ab9c77376ca786092058848d3">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="a73ac279311593a75fe528e34b613330e" name="a73ac279311593a75fe528e34b613330e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a73ac279311593a75fe528e34b613330e">◆ </a></span>Execute()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::Execute </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Execute accumulated command list. No more commands can be added until Wait is called. </p>
- <p>Implements <a class="el" href="class_compute_queue.html#aa4d942593a494177c5d563b7cd2262dc">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="aebd08c87361fd17f88d06ddcdbdd9154" name="aebd08c87361fd17f88d06ddcdbdd9154"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aebd08c87361fd17f88d06ddcdbdd9154">◆ </a></span>ScheduleReadback()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::ScheduleReadback </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>inDst</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>inSrc</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Schedule buffer to be copied from GPU to CPU. A reference to the buffers is added to make sure they stay alive until execution finishes. </p>
- <p>Implements <a class="el" href="class_compute_queue.html#a73610cdc648e585b2f1be6fab93d36dc">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="a56704247ac47e70040c48a7266d289f2" name="a56704247ac47e70040c48a7266d289f2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a56704247ac47e70040c48a7266d289f2">◆ </a></span>SetBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::SetBuffer </td>
- <td>(</td>
- <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>inBuffer</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bind a read only buffer to the shader. Note that the contents of the buffer cannot be modified on CPU until execution finishes (only relevant for buffers of type UploadBuffer). A reference to the buffer is added to make sure it stays alive until execution finishes. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inName</td><td>Name of the buffer as specified in the shader. </td></tr>
- <tr><td class="paramname">inBuffer</td><td>The buffer to bind. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="class_compute_queue.html#a5f9ab06cc5cbb57555f4b9270dc6ad88">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="a1a1fc266c9f9100892113f6e8e9de63d" name="a1a1fc266c9f9100892113f6e8e9de63d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1a1fc266c9f9100892113f6e8e9de63d">◆ </a></span>SetConstantBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::SetConstantBuffer </td>
- <td>(</td>
- <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>inBuffer</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bind a constant buffer to the shader. Note that the contents of the buffer cannot be modified until execution finishes. A reference to the buffer is added to make sure it stays alive until execution finishes. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inName</td><td>Name of the buffer as specified in the shader. </td></tr>
- <tr><td class="paramname">inBuffer</td><td>The buffer to bind. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="class_compute_queue.html#a788e8beed4a3dd1fa6fc0420d15b33e0">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="ad48fbd0850250e43a4b3c04c3ba882a7" name="ad48fbd0850250e43a4b3c04c3ba882a7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad48fbd0850250e43a4b3c04c3ba882a7">◆ </a></span>SetRWBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::SetRWBuffer </td>
- <td>(</td>
- <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>inBuffer</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257">EBarrier</a></td> <td class="paramname"><span class="paramname"><em>inBarrier</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="class_compute_queue.html#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">EBarrier::Yes</a></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bind a read/write buffer to the shader. A reference to the buffer is added to make sure it stays alive until execution finishes. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inName</td><td>Name of the buffer as specified in the shader. </td></tr>
- <tr><td class="paramname">inBuffer</td><td>The buffer to bind. </td></tr>
- <tr><td class="paramname">inBarrier</td><td>If set to Yes, a barrier will be placed before accessing the buffer to ensure all previous writes to the buffer are visible. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="class_compute_queue.html#ad2aa6970bb1262c0f17cbef667cdac3a">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="ae6feb8658c2df5ad3db52aca4d75c067" name="ae6feb8658c2df5ad3db52aca4d75c067"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae6feb8658c2df5ad3db52aca4d75c067">◆ </a></span>SetShader()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::SetShader </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_compute_shader.html">ComputeShader</a> *</td> <td class="paramname"><span class="paramname"><em>inShader</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Activate a shader. Shader must be set first before buffers can be bound. After every Dispatch call, the shader must be set again and all buffers must be bound again. </p>
- <p>Implements <a class="el" href="class_compute_queue.html#a94d39bef27c325404efbfda2ff188172">ComputeQueue</a>.</p>
- </div>
- </div>
- <a id="a5bd33aec36575483ad95fb73c7d2583b" name="a5bd33aec36575483ad95fb73c7d2583b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5bd33aec36575483ad95fb73c7d2583b">◆ </a></span>Wait()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ComputeQueueCPU::Wait </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>After executing, this waits until execution is done. This also makes sure that any readback operations have completed and the data is available on CPU. </p>
- <p>Implements <a class="el" href="class_compute_queue.html#a54f221ffaf3ee9d4cb28f7b16d1d19cd">ComputeQueue</a>.</p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Compute/CPU/<a class="el" href="_compute_queue_c_p_u_8h_source.html">ComputeQueueCPU.h</a></li>
- <li>Jolt/Compute/CPU/<a class="el" href="_compute_queue_c_p_u_8cpp.html">ComputeQueueCPU.cpp</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_compute_queue_c_p_u.html">ComputeQueueCPU</a></li>
- <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>
- </ul>
- </div>
- </body>
- </html>
|