QRenderPassFilter Class | Qt 3D 5.12.8

Qt 5.12 | Qt 3D | C++ Classes | QRenderPassFilter

Qt 5.12.8 Reference Documentation

# QRenderPassFilter Class

(Qt3DRender::QRenderPassFilter)

Provides storage for vectors of Filter Keys and Parameters. More...

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

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

## Public Functions

| QRenderPassFilter(Qt3DCore::QNode *parent = nullptr)
void | addMatch(Qt3DRender::QFilterKey *filterKey)
void | addParameter(Qt3DRender::QParameter *parameter)
QVector<Qt3DRender::QFilterKey *> | matchAny() const
QVector<Qt3DRender::QParameter *> | parameters() const
void | removeMatch(Qt3DRender::QFilterKey *filterKey)
void | removeParameter(Qt3DRender::QParameter *parameter)

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

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject
- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject
- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject
- 1 protected function inherited from Qt3DRender::QFrameGraphNode
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

Provides storage for vectors of Filter Keys and Parameters.

A Qt3DRender::QRenderPassFilter FrameGraph node is used to select which Qt3DRender::QRenderPass objects are selected for drawing. QRenderPassFilter specifies a list of Qt3DRender::QFilterKey objects and Qt3DRender::QParameter objects. When QRenderPassFilter is present in the FrameGraph, only the QRenderPass objects, whose Qt3DRender::QFilterKey objects match the keys in QRenderPassFilter are selected for rendering. If no QRenderPassFilter is present, then all QRenderPass objects are selected for rendering. The parameters in the list can be used to set values for shader parameters. The parameters in QRenderPassFilter are overridden by parameters in QTechniqueFilter, QTechnique and QRenderPass.

## Member Function Documentation

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

The constructor creates an instance with the specified parent.

### void QRenderPassFilter::addMatch(Qt3DRender::QFilterKey *filterKey)

Add the filterKey to the match vector.

### void QRenderPassFilter::addParameter(Qt3DRender::QParameter *parameter)

Add the given parameter to the parameter vector.

### QVector<Qt3DRender::QFilterKey *> QRenderPassFilter::matchAny() const

Returns a vector of the current keys for the filter.

### QVector<Qt3DRender::QParameter *> QRenderPassFilter::parameters() const

Returns the current vector of parameters.

### void QRenderPassFilter::removeMatch(Qt3DRender::QFilterKey *filterKey)

Remove the filterKey from the match vector.

### void QRenderPassFilter::removeParameter(Qt3DRender::QParameter *parameter)

Remove the given parameter from the parameter vector.