QComputeCommand

PyQt5.Qt3DRender.QComputeCommand

Inherits from QComponent.

Description

QComponent to issue work for the compute shader on GPU.

A 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. 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. The 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.

Enums

RunType

TODO

Member	Value	Description
Continuous	TODO	TODO
Manual	TODO	TODO

Methods

__init__(parent: QNode = None)

The constructor creates a new QComputeCommand instance with the specified parent.

---

runType() → RunType

TODO

---

setRunType(RunType)

TODO

---

setWorkGroupX(int)

Sets the workgroup for the first dimension to workGroupX.

See also

workGroupX().

---

setWorkGroupY(int)

Sets the workgroup for the second dimension to workGroupY.

See also

workGroupY().

---

setWorkGroupZ(int)

Sets the workgroup for the third dimension to workGroupZ.

See also

workGroupZ().

---

trigger(frameCount: int = 1)

TODO

---

trigger(int, int, int, frameCount: int = 1)

TODO

---

workGroupX() → int

See also

setWorkGroupX().

---

workGroupY() → int

See also

setWorkGroupY().

---

workGroupZ() → int

See also

setWorkGroupZ().

Signals

runTypeChanged()

TODO

---

workGroupXChanged()

TODO

---

workGroupYChanged()

TODO

---

workGroupZChanged()

TODO