QEffect

PyQt5.Qt3DRender.QEffect

Inherits from QNode.

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, QParameter.

Methods

__init__(parent: QNode = None)

TODO

---

addParameter(QParameter)

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.

---

addTechnique(QTechnique)

Adds a new technique t to the effect. It sends a QPropertyNodeAddedChange to the backend.

---

parameters() → List[QParameter]

Returns the list of parameters used by the effect.

---

removeParameter(QParameter)

Removes a parameter parameter from the effect.

---

removeTechnique(QTechnique)

Removes a technique t from the effect.

---

techniques() → List[QTechnique]

Returns the list of techniques used by the effect.