<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qcomputecommand.cpp --> <title>ComputeCommand QML Type | Qt 3D 5.9</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.9</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-core-qmlmodule.html">QML Types</a></td><td >ComputeCommand QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</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">ComputeCommand QML Type</h1> <span class="subtitle"></span> <!-- $$$ComputeCommand-brief --> <p>Component to issue work for the compute shader on GPU <a href="#details">More...</a></p> <!-- @@@ComputeCommand --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import </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-computecommand.html"><a href="qt3drender-qcomputecommand.html">QComputeCommand</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt3d-core-component3d.html">Component3D</a></p> </td></tr></table></div><ul> <li><a href="qml-computecommand-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-computecommand.html#workGroupX-prop">workGroupX</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-computecommand.html#workGroupY-prop">workGroupY</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-computecommand.html#workGroupZ-prop">workGroupZ</a></b></b> : int</li> </ul> <!-- $$$ComputeCommand-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>A <a href="qml-computecommand.html">ComputeCommand</a> is used to issue work for the compute shader. The compute shader is specified in the Material component of the same entity the <a href="qml-computecommand.html">ComputeCommand</a> is added to. The <a href="qml-computecommand.html#workGroupX-prop">workGroupX</a>, <a href="qml-computecommand.html#workGroupY-prop">workGroupY</a> and <a href="qml-computecommand.html#workGroupZ-prop">workGroupZ</a> properties specify the work group sizes for the compute shader invocation. <a href="qml-qt3d-render-dispatchcompute.html">DispatchCompute</a> node needs to be present in the FrameGraph to actually issue the commands.</p> <!-- @@@ComputeCommand --> <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> 2017 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>