QComputeCommand Class▲
-
Header: QComputeCommand
-
Since: Qt 5.7
-
qmake: QT += 3drender
-
Inherited By:
-
Instantiated By: qml-computecommand.xml
-
Inherits: Qt3DCore::QComponent
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.
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.
Property Documentation▲
workGroupX : int▲
Specifies X workgroup size.
Access functions:
-
int workGroupX() const
-
void setWorkGroupX(int workGroupX)
Notifier signal:
-
void workGroupXChanged()
workGroupY : int▲
Specifies Y workgroup size.
Access functions:
-
int workGroupY() const
-
void setWorkGroupY(int workGroupY)
Notifier signal:
-
void workGroupYChanged()
workGroupZ : int▲
Specifies Z workgroup size.
Access functions:
-
int workGroupZ() const
-
void setWorkGroupZ(int workGroupZ)
Notifier signal:
-
void workGroupZChanged()
Member Function Documentation▲
[explicit] QComputeCommand::QComputeCommand(Qt3DCore::QNode *parent = nullptr)▲
The constructor creates a new Qt3DRender::QComputeCommand instance with the specified parent.
void QComputeCommand::setWorkGroupX(int workGroupX)▲
Sets the workgroup for the first dimension to workGroupX.
Setter function for property workGroupX.
See Also▲
See also workGroupX()
void QComputeCommand::setWorkGroupY(int workGroupY)▲
Sets the workgroup for the second dimension to workGroupY.
Setter function for property workGroupY.
See Also▲
See also workGroupY()
void QComputeCommand::setWorkGroupZ(int workGroupZ)▲
Sets the workgroup for the third dimension to workGroupZ.
Setter function for property workGroupZ.
See Also▲
See also workGroupZ()