QDispatchCompute Class | Qt 3D 5.12.9

- Qt 5.12
- Qt 3D
- C++ Classes
- QDispatchCompute
- Qt 5.12.9 Reference Documentation

# QDispatchCompute Class

(Qt3DRender::QDispatchCompute)

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

Header: | #include <QDispatchCompute>
qmake: | QT += 3drender
Since: | Qt 5.7
Instantiated By: | DispatchCompute
Inherits: | Qt3DRender::QFrameGraphNode

- List of all members, including inherited members
- Obsolete members

## Properties

- workGroupX : int
- workGroupY : int
- workGroupZ : int

- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject

## Public Functions

| QDispatchCompute(Qt3DCore::QNode *parent = nullptr)
int | workGroupX() const
int | workGroupY() const
int | workGroupZ() const

- 1 public function inherited from Qt3DRender::QFrameGraphNode
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Public Slots

void | setWorkGroupX(int workGroupX)
void | setWorkGroupY(int workGroupY)
void | setWorkGroupZ(int workGroupZ)

- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject

## Signals

void | workGroupXChanged()
void | workGroupYChanged()
void | workGroupZChanged()

- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 1 protected function inherited from Qt3DRender::QFrameGraphNode
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

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

A Qt3DRender::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.

## Property Documentation

### workGroupX : int

Specifies X workgroup.

Access functions:

int | workGroupX() const
void | setWorkGroupX(int workGroupX)

Notifier signal:

void | workGroupXChanged()

### workGroupY : int

Specifies Y workgroup.

Access functions:

int | workGroupY() const
void | setWorkGroupY(int workGroupY)

Notifier signal:

void | workGroupYChanged()

### workGroupZ : int

Specifies Z workgroup.

Access functions:

int | workGroupZ() const
void | setWorkGroupZ(int workGroupZ)

Notifier signal:

void | workGroupZChanged()

## Member Function Documentation

### QDispatchCompute::QDispatchCompute(Qt3DCore::QNode *parent = nullptr)

The constructor creates an instance with the specified parent.