QComputeCommand Class
class Qt3DRender::QComputeCommandQComponent to issue work for the compute shader on GPU. More...
Header: | #include <QComputeCommand> |
qmake: | QT += 3drender |
Since: | Qt 5.7 |
Instantiated By: | ComputeCommand |
Inherits: | Qt3DCore::QComponent |
This class was introduced in Qt 5.7.
Public Functions
void | setWorkGroupX(int workGroupX) |
void | setWorkGroupY(int workGroupY) |
void | setWorkGroupZ(int workGroupZ) |
void | trigger(int frameCount = 1) |
void | trigger(int workGroupX, int workGroupY, int workGroupZ, int frameCount = 1) |
Detailed Description
A Qt3DRender::QComputeCommand is used to issue work for the compute shader. The compute shader is specified in the QMaterial component of the same entity the QComputeCommand is added to. The workGroupX, workGroupY and workGroupZ properties specify the work group sizes for the compute shader invocation. Qt3DRender::QDispatchCompute node needs to be present in the FrameGraph to actually issue the commands.
Note: If the rendering policy is set to Qt3DRender::QRenderSettings::OnDemand and there are no changes to the scene, the ComputeCommand will not be invoked repeatedly. The Qt3DRender::QRenderSettings::Always render policy must be set for the ComputeCommand to be repeatedly invoked if there are no other changes to the scene that triggers rendering a new frame.
Member Function Documentation
void QComputeCommand::setWorkGroupX(int workGroupX)
Sets the workgroup for the first dimension to workGroupX.
void QComputeCommand::setWorkGroupY(int workGroupY)
Sets the workgroup for the second dimension to workGroupY.
void QComputeCommand::setWorkGroupZ(int workGroupZ)
Sets the workgroup for the third dimension to workGroupZ.
void QComputeCommand::trigger(int frameCount = 1)
When the run type is set to Manual, calling trigger will make the compute command be executed for the next frameCount frames. Upon completion of the execution, the enabled property will be set to false.
void QComputeCommand::trigger(int workGroupX, int workGroupY, int workGroupZ, int frameCount = 1)
When the run type is set to Manual, calling trigger will make the compute command be executed for the next frameCount frames. Upon completion of the execution, the enabled property will be set to false. The size of the workgroup previously set will be overridden with workGroupX, workGroupY, workGroupZ.