PySide6.Qt3DRender.Qt3DRender.QDispatchCompute

class QDispatchCompute

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

Synopsis

Properties

• workGroupXᅟ

• workGroupYᅟ

• workGroupZᅟ

Methods

• def __init__()

• def workGroupX()

• def workGroupY()

• def workGroupZ()

Slots

• def setWorkGroupX()

• def setWorkGroupY()

• def setWorkGroupZ()

Signals

• def workGroupXChanged()

• def workGroupYChanged()

• def workGroupZChanged()

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 .

Note

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

property workGroupXᅟ: int

Specifies X workgroup.

Access functions:

• workGroupX()

• setWorkGroupX()

• Signal workGroupXChanged()

property workGroupYᅟ: int

Specifies Y workgroup.

Access functions:

• workGroupY()

• setWorkGroupY()

• Signal workGroupYChanged()

property workGroupZᅟ: int

Specifies Z workgroup.

Access functions:

• workGroupZ()

• setWorkGroupZ()

• Signal workGroupZChanged()

__init__([parent=None])

Parameters:

parent – QNode

The constructor creates an instance with the specified parent.

setWorkGroupX(workGroupX)

Parameters:

workGroupX – int

See also

workGroupX()

Setter of property workGroupXᅟ .

setWorkGroupY(workGroupY)

Parameters:

workGroupY – int

See also

workGroupY()

Setter of property workGroupYᅟ .

setWorkGroupZ(workGroupZ)

Parameters:

workGroupZ – int

See also

workGroupZ()

Setter of property workGroupZᅟ .

workGroupX()

Return type:

int

See also

setWorkGroupX()

Getter of property workGroupXᅟ .

workGroupXChanged()

Notification signal of property workGroupXᅟ .

workGroupY()

Return type:

int

See also

setWorkGroupY()

Getter of property workGroupYᅟ .

workGroupYChanged()

Notification signal of property workGroupYᅟ .

workGroupZ()

Return type:

int

See also

setWorkGroupZ()

Getter of property workGroupZᅟ .

workGroupZChanged()

Notification signal of property workGroupZᅟ .