QEffect Class
(Qt3DRender::QEffect)The base class for effects in a Qt 3D scene. More...
Header: | #include <QEffect> |
qmake: | QT += 3drender |
Since: | Qt 5.7 |
Instantiated By: | Effect |
Inherits: | Qt3DCore::QNode |
Public Functions
QEffect(Qt3DCore::QNode *parent = nullptr) | |
virtual | ~QEffect() |
void | addParameter(Qt3DRender::QParameter *parameter) |
void | addTechnique(Qt3DRender::QTechnique *t) |
QVector<Qt3DRender::QParameter *> | parameters() const |
void | removeParameter(Qt3DRender::QParameter *parameter) |
void | removeTechnique(Qt3DRender::QTechnique *t) |
QVector<Qt3DRender::QTechnique *> | techniques() const |
- 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
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject
Detailed Description
The base class for effects in a Qt 3D scene.
The QEffect class combines a set of techniques and parameters used by those techniques to produce a rendering effect for a material.
An QEffect instance should be shared among several QMaterial instances when possible.
QEffect *effect = new QEffect(); // Create technique, render pass and shader QTechnique *gl3Technique = new QTechnique(); QRenderPass *gl3Pass = new QRenderPass(); QShaderProgram *glShader = new QShaderProgram(); // Set the shader on the render pass gl3Pass->setShaderProgram(glShader); // Add the pass to the technique gl3Technique->addRenderPass(gl3Pass); // Set the targeted GL version for the technique gl3Technique->graphicsApiFilter()->setApi(QGraphicsApiFilter::OpenGL); gl3Technique->graphicsApiFilter()->setMajorVersion(3); gl3Technique->graphicsApiFilter()->setMinorVersion(1); gl3Technique->graphicsApiFilter()->setProfile(QGraphicsApiFilter::CoreProfile); // Add the technique to the effect effect->addTechnique(gl3Technique);
A QParameter defined on an Effect is overridden by a QParameter (of the same name) defined in a QMaterial, QTechniqueFilter, QRenderPassFilter.
See also QMaterial, QTechnique, and QParameter.
Member Function Documentation
QEffect::QEffect(Qt3DCore::QNode *parent = nullptr)
Default constructs an instance of QEffect.
[virtual]
QEffect::~QEffect()
Destroys the instance of QEffect. The destructor is virtual.
void QEffect::addParameter(Qt3DRender::QParameter *parameter)
Adds parameter to the effect. It sends a QPropertyNodeAddedChange to the backend. The parameter will be used to set a corresponding uniform value in the shader used by this effect.
void QEffect::addTechnique(Qt3DRender::QTechnique *t)
Adds a new technique t to the effect. It sends a QPropertyNodeAddedChange to the backend.
QVector<Qt3DRender::QParameter *> QEffect::parameters() const
Returns the list of parameters used by the effect.
void QEffect::removeParameter(Qt3DRender::QParameter *parameter)
Removes a parameter parameter from the effect.
void QEffect::removeTechnique(Qt3DRender::QTechnique *t)
Removes a technique t from the effect.
QVector<Qt3DRender::QTechnique *> QEffect::techniques() const
Returns the list of techniques used by the effect.
© 2019 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.