ComputeCommand QML Type

Component to issue work for the compute shader on GPU. More...

Import Statement:	import Qt3D.Render 2.0
Since:	Qt 5.7
Instantiates:	QComputeCommand
Inherits:	Component3D

• List of all members, including inherited members

Properties

• runType : enumeration
• workGroupX : int
• workGroupY : int
• workGroupZ : int

Detailed Description

A ComputeCommand is used to issue work for the compute shader. The compute shader is specified in the Material component of the same entity the ComputeCommand is added to. The workGroupX, workGroupY and workGroupZ properties specify the work group sizes for the compute shader invocation. DispatchCompute node needs to be present in the FrameGraph to actually issue the commands. The execution behavior of the compute command can be controlled with the run type property.

Note: If the rendering policy is set to RenderSettings.OnDemand, the run type is set to Continuous and there are no changes to the scene, the ComputeCommand will not be invoked repeatedly. The RenderSettings.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

runType : enumeration

Specifies whether the compute command should be performed every frame or manually triggered.

Constant	Description
ComputeCommand.Continuous	Compute command is executed everyframe. This is the default.
ComputeCommand.Manual	CompouteCommand is executed for a given number of frames and then the component disables itself.

workGroupX : int

Specifies X workgroup size.

workGroupY : int

Specifies Y workgroup size.

workGroupZ : int

Specifies Z workgroup size.