<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdispatchcompute.cpp -->
<title>DispatchCompute QML Type | Qt 3D 5.12.2</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-qml.html">QML Types</a></td><td >DispatchCompute QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">DispatchCompute QML Type</h1>
<span class="subtitle"></span>
<!-- $$$DispatchCompute-brief -->
<p>FrameGraph node to issue work for the compute shader on GPU. <a href="#details">More...</a></p>
<!-- @@@DispatchCompute -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Render 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-dispatchcompute.html"><a href="qt3drender-qdispatchcompute.html">QDispatchCompute</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt3d-render-framegraphnode.html">FrameGraphNode</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt3d-render-dispatchcompute-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qt3d-render-dispatchcompute.html#workGroupX-prop">workGroupX</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-render-dispatchcompute.html#workGroupY-prop">workGroupY</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-render-dispatchcompute.html#workGroupZ-prop">workGroupZ</a></b></b> : int</li>
</ul>
<!-- $$$DispatchCompute-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A <a href="qml-qt3d-render-dispatchcompute.html">DispatchCompute</a> allows work to be issued for the compute shader to run on the GPU. The <a href="qml-qt3d-render-dispatchcompute.html#workGroupX-prop">workGroupX</a>, <a href="qml-qt3d-render-dispatchcompute.html#workGroupY-prop">workGroupY</a> and <a href="qml-qt3d-render-dispatchcompute.html#workGroupZ-prop">workGroupZ</a> properties specify the work group sizes for the compute shader invocation. <a href="qml-computecommand.html">ComputeCommand</a> components need to be added to entities to instruct Qt3D to select the materials and geometry from the entities for the compute invocation. The work group sizes for the shader invocation will be the maximum of the work group sizes specified in <a href="qml-qt3d-render-dispatchcompute.html">DispatchCompute</a> and <a href="qml-computecommand.html">ComputeCommand</a>.</p>
<!-- @@@DispatchCompute -->
<h2>Property Documentation</h2>
<!-- $$$workGroupX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="workGroupX-prop">
<td class="tblQmlPropNode"><p>
<a name="workGroupX-prop"></a><span class="name">workGroupX</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies X workgroup size.</p>
</div></div><!-- @@@workGroupX -->
<br/>
<!-- $$$workGroupY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="workGroupY-prop">
<td class="tblQmlPropNode"><p>
<a name="workGroupY-prop"></a><span class="name">workGroupY</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies Y workgroup size.</p>
</div></div><!-- @@@workGroupY -->
<br/>
<!-- $$$workGroupZ -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="workGroupZ-prop">
<td class="tblQmlPropNode"><p>
<a name="workGroupZ-prop"></a><span class="name">workGroupZ</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies Z workgroup size.</p>
</div></div><!-- @@@workGroupZ -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
