QRenderPassFilter Class

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

This class was introduced in Qt 5.7.

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)

Detailed Description

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 override parameters in QTechniqueFilter, QMaterial, QEffect, 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.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.