cpp
/
JoltPhysics
зеркало из https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
							<!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: ComputeQueue 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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_compute_queue.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_compute_queue-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ComputeQueue Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>A command queue for executing compute workloads on the GPU.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_compute_queue_8h_source.html">ComputeQueue.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ComputeQueue:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_compute_queue.png" usemap="#ComputeQueue_map" alt=""/>
  <map id="ComputeQueue_map" name="ComputeQueue_map">
<area href="class_ref_target.html" alt="RefTarget&lt; ComputeQueue &gt;" 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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1309e3ae62b5f5817e1094e872c2a257" id="r_a1309e3ae62b5f5817e1094e872c2a257"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257">EBarrier</a> { <a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">Yes</a>
, <a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257abafd7322c6e97d25b6299b5d6fe8920b">No</a>
 }</td></tr>
<tr class="memdesc:a1309e3ae62b5f5817e1094e872c2a257"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a barrier should be placed before accessing the buffer.  <a href="#a1309e3ae62b5f5817e1094e872c2a257">More...</a><br /></td></tr>
<tr class="separator:a1309e3ae62b5f5817e1094e872c2a257"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ad1e2dc9b2bc00f02087e8317921ee806" id="r_ad1e2dc9b2bc00f02087e8317921ee806"><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="#ad1e2dc9b2bc00f02087e8317921ee806">~ComputeQueue</a> ()=default</td></tr>
<tr class="memdesc:ad1e2dc9b2bc00f02087e8317921ee806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:ad1e2dc9b2bc00f02087e8317921ee806"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94d39bef27c325404efbfda2ff188172" id="r_a94d39bef27c325404efbfda2ff188172"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94d39bef27c325404efbfda2ff188172">SetShader</a> (const <a class="el" href="class_compute_shader.html">ComputeShader</a> *inShader)=0</td></tr>
<tr class="separator:a94d39bef27c325404efbfda2ff188172"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a788e8beed4a3dd1fa6fc0420d15b33e0" id="r_a788e8beed4a3dd1fa6fc0420d15b33e0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a788e8beed4a3dd1fa6fc0420d15b33e0">SetConstantBuffer</a> (const char *inName, const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer)=0</td></tr>
<tr class="memdesc:a788e8beed4a3dd1fa6fc0420d15b33e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind a constant buffer to the shader. Note that the contents of the buffer cannot be modified until execution finishes.  <br /></td></tr>
<tr class="separator:a788e8beed4a3dd1fa6fc0420d15b33e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f9ab06cc5cbb57555f4b9270dc6ad88" id="r_a5f9ab06cc5cbb57555f4b9270dc6ad88"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f9ab06cc5cbb57555f4b9270dc6ad88">SetBuffer</a> (const char *inName, const <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer)=0</td></tr>
<tr class="memdesc:a5f9ab06cc5cbb57555f4b9270dc6ad88"><td class="mdescLeft">&#160;</td><td class="mdescRight">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).  <br /></td></tr>
<tr class="separator:a5f9ab06cc5cbb57555f4b9270dc6ad88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2aa6970bb1262c0f17cbef667cdac3a" id="r_ad2aa6970bb1262c0f17cbef667cdac3a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2aa6970bb1262c0f17cbef667cdac3a">SetRWBuffer</a> (const char *inName, <a class="el" href="class_compute_buffer.html">ComputeBuffer</a> *inBuffer, <a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257">EBarrier</a> inBarrier=<a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">EBarrier::Yes</a>)=0</td></tr>
<tr class="separator:ad2aa6970bb1262c0f17cbef667cdac3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdca367ab9c77376ca786092058848d3" id="r_abdca367ab9c77376ca786092058848d3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abdca367ab9c77376ca786092058848d3">Dispatch</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsX, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsY=1, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inThreadGroupsZ=1)=0</td></tr>
<tr class="memdesc:abdca367ab9c77376ca786092058848d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch a compute shader with the specified number of thread groups.  <br /></td></tr>
<tr class="separator:abdca367ab9c77376ca786092058848d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73610cdc648e585b2f1be6fab93d36dc" id="r_a73610cdc648e585b2f1be6fab93d36dc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73610cdc648e585b2f1be6fab93d36dc">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)=0</td></tr>
<tr class="memdesc:a73610cdc648e585b2f1be6fab93d36dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedule buffer to be copied from GPU to CPU.  <br /></td></tr>
<tr class="separator:a73610cdc648e585b2f1be6fab93d36dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4d942593a494177c5d563b7cd2262dc" id="r_aa4d942593a494177c5d563b7cd2262dc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa4d942593a494177c5d563b7cd2262dc">Execute</a> ()=0</td></tr>
<tr class="memdesc:aa4d942593a494177c5d563b7cd2262dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute accumulated command list.  <br /></td></tr>
<tr class="separator:aa4d942593a494177c5d563b7cd2262dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f221ffaf3ee9d4cb28f7b16d1d19cd" id="r_a54f221ffaf3ee9d4cb28f7b16d1d19cd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a54f221ffaf3ee9d4cb28f7b16d1d19cd">Wait</a> ()=0</td></tr>
<tr class="memdesc:a54f221ffaf3ee9d4cb28f7b16d1d19cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">After executing, this waits until execution is done.  <br /></td></tr>
<tr class="separator:a54f221ffaf3ee9d4cb28f7b16d1d19cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc3e87cf4f95f62c8ee51cf3ee3b2a1e" id="r_acc3e87cf4f95f62c8ee51cf3ee3b2a1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc3e87cf4f95f62c8ee51cf3ee3b2a1e">ExecuteAndWait</a> ()</td></tr>
<tr class="memdesc:acc3e87cf4f95f62c8ee51cf3ee3b2a1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute and wait for the command list to finish.  <br /></td></tr>
<tr class="separator:acc3e87cf4f95f62c8ee51cf3ee3b2a1e"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeQueue &gt;</a></td></tr>
<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>
<tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</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> &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>
<tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <br /></td></tr>
<tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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">&#160;</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">&#160;</td></tr>
<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>
<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>
<tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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">&#160;</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">&#160;</td></tr>
<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>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</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_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; ComputeQueue &gt;</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&#160;</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">&#160;</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">&#160;</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="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeQueue &gt;</a></td></tr>
<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>
<tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</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">&#160;</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="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; ComputeQueue &gt;</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>&#160;</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">&#160;</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">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A command queue for executing compute workloads on the GPU. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a1309e3ae62b5f5817e1094e872c2a257" name="a1309e3ae62b5f5817e1094e872c2a257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1309e3ae62b5f5817e1094e872c2a257">&#9670;&#160;</a></span>EBarrier</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum class <a class="el" href="#a1309e3ae62b5f5817e1094e872c2a257">ComputeQueue::EBarrier</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>If a barrier should be placed before accessing the buffer. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435" name="a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435"></a>Yes&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1309e3ae62b5f5817e1094e872c2a257abafd7322c6e97d25b6299b5d6fe8920b" name="a1309e3ae62b5f5817e1094e872c2a257abafd7322c6e97d25b6299b5d6fe8920b"></a>No&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad1e2dc9b2bc00f02087e8317921ee806" name="ad1e2dc9b2bc00f02087e8317921ee806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1e2dc9b2bc00f02087e8317921ee806">&#9670;&#160;</a></span>~ComputeQueue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> ComputeQueue::~ComputeQueue </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">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abdca367ab9c77376ca786092058848d3" name="abdca367ab9c77376ca786092058848d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdca367ab9c77376ca786092058848d3">&#9670;&#160;</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">virtual void ComputeQueue::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><span class="paramdefsep"> = </span><span class="paramdefval">1</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><span class="paramdefsep"> = </span><span class="paramdefval">1</span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Dispatch a compute shader with the specified number of thread groups. </p>

</div>
</div>
<a id="aa4d942593a494177c5d563b7cd2262dc" name="aa4d942593a494177c5d563b7cd2262dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4d942593a494177c5d563b7cd2262dc">&#9670;&#160;</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">virtual void ComputeQueue::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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Execute accumulated command list. </p>

</div>
</div>
<a id="acc3e87cf4f95f62c8ee51cf3ee3b2a1e" name="acc3e87cf4f95f62c8ee51cf3ee3b2a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc3e87cf4f95f62c8ee51cf3ee3b2a1e">&#9670;&#160;</a></span>ExecuteAndWait()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void ComputeQueue::ExecuteAndWait </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Execute and wait for the command list to finish. </p>

</div>
</div>
<a id="a73610cdc648e585b2f1be6fab93d36dc" name="a73610cdc648e585b2f1be6fab93d36dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73610cdc648e585b2f1be6fab93d36dc">&#9670;&#160;</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">virtual void ComputeQueue::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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Schedule buffer to be copied from GPU to CPU. </p>

</div>
</div>
<a id="a5f9ab06cc5cbb57555f4b9270dc6ad88" name="a5f9ab06cc5cbb57555f4b9270dc6ad88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f9ab06cc5cbb57555f4b9270dc6ad88">&#9670;&#160;</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">virtual void ComputeQueue::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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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). </p>

</div>
</div>
<a id="a788e8beed4a3dd1fa6fc0420d15b33e0" name="a788e8beed4a3dd1fa6fc0420d15b33e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a788e8beed4a3dd1fa6fc0420d15b33e0">&#9670;&#160;</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">virtual void ComputeQueue::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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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. </p>

</div>
</div>
<a id="ad2aa6970bb1262c0f17cbef667cdac3a" name="ad2aa6970bb1262c0f17cbef667cdac3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2aa6970bb1262c0f17cbef667cdac3a">&#9670;&#160;</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">virtual void ComputeQueue::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="#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="#a1309e3ae62b5f5817e1094e872c2a257a93cba07454f06a4a960172bbd6e2a435">EBarrier::Yes</a></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Bind a read/write buffer to the shader. </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>

</div>
</div>
<a id="a94d39bef27c325404efbfda2ff188172" name="a94d39bef27c325404efbfda2ff188172"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94d39bef27c325404efbfda2ff188172">&#9670;&#160;</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">virtual void ComputeQueue::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">pure 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>

</div>
</div>
<a id="a54f221ffaf3ee9d4cb28f7b16d1d19cd" name="a54f221ffaf3ee9d4cb28f7b16d1d19cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54f221ffaf3ee9d4cb28f7b16d1d19cd">&#9670;&#160;</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">virtual void ComputeQueue::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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>After executing, this waits until execution is done. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Compute/<a class="el" href="_compute_queue_8h_source.html">ComputeQueue.h</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.html">ComputeQueue</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>