QDispatchCompute#

FrameGraph node to issue work for the compute shader on GPU. More

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QDispatchCompute

Synopsis#

Properties#

Functions#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A QDispatchCompute allows work to be issued for the compute shader to run on the GPU. The workGroupX , workGroupY and workGroupZ properties specify the work group sizes for the compute shader invocation. QComputeCommand components need to be added to entities to instruct Qt3D to select the materials and geometry from the entities for the compute invocation. The work group sizes for the shader invocation will be the maximum of the work group sizes specified in QDispatchCompute and QComputeCommand .

class PySide6.Qt3DRender.Qt3DRender.QDispatchCompute([parent=None])#
Parameters:

parentPySide6.Qt3DCore.Qt3DCore.QNode

The constructor creates an instance with the specified parent.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupX: int#

Specifies X workgroup.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupY: int#

Specifies Y workgroup.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupZ: int#

Specifies Z workgroup.

Access functions:
PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.setWorkGroupX(workGroupX)#
Parameters:

workGroupX – int

See also

workGroupX()

Setter of property workGroupX .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.setWorkGroupY(workGroupY)#
Parameters:

workGroupY – int

See also

workGroupY()

Setter of property workGroupY .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.setWorkGroupZ(workGroupZ)#
Parameters:

workGroupZ – int

See also

workGroupZ()

Setter of property workGroupZ .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupX()#
Return type:

int

See also

setWorkGroupX()

Getter of property workGroupX .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupXChanged()#

Notification signal of property workGroupX .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupY()#
Return type:

int

See also

setWorkGroupY()

Getter of property workGroupY .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupYChanged()#

Notification signal of property workGroupY .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupZ()#
Return type:

int

See also

setWorkGroupZ()

Getter of property workGroupZ .

PySide6.Qt3DRender.Qt3DRender.QDispatchCompute.workGroupZChanged()#

Notification signal of property workGroupZ .