Qt3DRender.QComputeCommand¶
QComponent
to issue work for the compute shader on GPU. More…

Synopsis¶
Functions¶
def
runType
()def
workGroupX
()def
workGroupY
()def
workGroupZ
()
Slots¶
def
setRunType
(runType)def
setWorkGroupX
(workGroupX)def
setWorkGroupY
(workGroupY)def
setWorkGroupZ
(workGroupZ)def
trigger
([frameCount=1])def
trigger
(workGroupX, workGroupY, workGroupZ[, frameCount=1])
Signals¶
def
runTypeChanged
()def
workGroupXChanged
()def
workGroupYChanged
()def
workGroupZChanged
()
Detailed Description¶
A
QComputeCommand
is used to issue work for the compute shader. The compute shader is specified in theQMaterial
component of the same entity theQComputeCommand
is added to. TheworkGroupX
,workGroupY
andworkGroupZ
properties specify the work group sizes for the compute shader invocation.QDispatchCompute
node needs to be present in the FrameGraph to actually issue the commands.Note
If the rendering policy is set to
OnDemand
and there are no changes to the scene, the ComputeCommand will not be invoked repeatedly. TheAlways
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.
-
class
PySide2.Qt3DRender.Qt3DRender.
QComputeCommand
([parent=None])¶ - param parent
QNode
The constructor creates a new
QComputeCommand
instance with the specifiedparent
.
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
RunType
¶
New in version 5.13.
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
runTypeChanged
()¶
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
setRunType
(runType)¶ - Parameters
runType –
RunType
See also
runType()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
setWorkGroupX
(workGroupX)¶ - Parameters
workGroupX –
int
Sets the workgroup for the first dimension to
workGroupX
.See also
workGroupX()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
setWorkGroupY
(workGroupY)¶ - Parameters
workGroupY –
int
Sets the workgroup for the second dimension to
workGroupY
.See also
workGroupY()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
setWorkGroupZ
(workGroupZ)¶ - Parameters
workGroupZ –
int
Sets the workgroup for the third dimension to
workGroupZ
.See also
workGroupZ()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
trigger
([frameCount=1])¶ - Parameters
frameCount –
int
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.
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
trigger
(workGroupX, workGroupY, workGroupZ[, frameCount=1]) - Parameters
workGroupX –
int
workGroupY –
int
workGroupZ –
int
frameCount –
int
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 withworkGroupX
,workGroupY
,workGroupZ
.
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupX
()¶ - Return type
int
See also
setWorkGroupX()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupXChanged
()¶
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupY
()¶ - Return type
int
See also
setWorkGroupY()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupYChanged
()¶
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupZ
()¶ - Return type
int
See also
setWorkGroupZ()
-
PySide2.Qt3DRender.Qt3DRender.QComputeCommand.
workGroupZChanged
()¶