QShaderProgram Class

class Qt3DRender::QShaderProgram

Verkapselt ein Shader-Programm. Mehr...

Kopfzeile: #include <QShaderProgram>
CMake: find_package(Qt6 REQUIRED COMPONENTS 3drender)
target_link_libraries(mytarget PRIVATE Qt6::3drender)
qmake: QT += 3drender
In QML: ShaderProgram
Vererbt: Qt3DCore::QNode
Status: Veraltet

Öffentliche Typen

enum Format { GLSL, SPIRV }
enum ShaderType { Vertex, Fragment, TessellationControl, TessellationEvaluation, Geometry, Compute }
enum Status { NotReady, Ready, Error }

Eigenschaften

Öffentliche Funktionen

QByteArray computeShaderCode() const
Qt3DRender::QShaderProgram::Format format() const
QByteArray fragmentShaderCode() const
QByteArray geometryShaderCode() const
QString log() const
void setFormat(Qt3DRender::QShaderProgram::Format format)
void setShaderCode(Qt3DRender::QShaderProgram::ShaderType type, const QByteArray &shaderCode)
QByteArray shaderCode(Qt3DRender::QShaderProgram::ShaderType type) const
Qt3DRender::QShaderProgram::Status status() const
QByteArray tessellationControlShaderCode() const
QByteArray tessellationEvaluationShaderCode() const
QByteArray vertexShaderCode() const

Öffentliche Slots

void setComputeShaderCode(const QByteArray &computeShaderCode)
void setFragmentShaderCode(const QByteArray &fragmentShaderCode)
void setGeometryShaderCode(const QByteArray &geometryShaderCode)
void setTessellationControlShaderCode(const QByteArray &tessellationControlShaderCode)
void setTessellationEvaluationShaderCode(const QByteArray &tessellationEvaluationShaderCode)
void setVertexShaderCode(const QByteArray &vertexShaderCode)

Signale

void computeShaderCodeChanged(const QByteArray &computeShaderCode)
void formatChanged(Qt3DRender::QShaderProgram::Format format)
void fragmentShaderCodeChanged(const QByteArray &fragmentShaderCode)
void geometryShaderCodeChanged(const QByteArray &geometryShaderCode)
void logChanged(const QString &log)
void statusChanged(Qt3DRender::QShaderProgram::Status status)
void tessellationControlShaderCodeChanged(const QByteArray &tessellationControlShaderCode)
void tessellationEvaluationShaderCodeChanged(const QByteArray &tessellationEvaluationShaderCode)
void vertexShaderCodeChanged(const QByteArray &vertexShaderCode)

Statische öffentliche Mitglieder

QByteArray loadSource(const QUrl &sourceUrl)

Detaillierte Beschreibung

Ein Shader-Programm besteht aus mehreren verschiedenen Shadern, wie z.B. Vertex- und Fragment-Shadern.

Qt3D füllt automatisch einen Satz von Standard-Uniformen aus, wenn sie während der Shader-Instrospektionsphase angetroffen werden.

Standard UniformZugehöriger Qt3D ParameternameGLSL-Deklaration
ModelMatrixmodelMatrixeinheitliche mat4 modelMatrix;
ViewMatrixviewMatrixuniform mat4 viewMatrix;
ProjektionsMatrixprojectionMatrixuniform mat4 projectionMatrix;
ModelViewMatrixmodelViewuniform mat4 modelView;
ViewProjectionMatrixviewProjectionMatrixuniform mat4 viewProjectionMatrix;
ModelViewProjectionMatrixmodelViewProjection
mvp
uniform mat4 modelViewProjection;
uniform mat4 mvp;
InverseModelMatrixinverseModelMatrixuniform mat4 inverseModelMatrix;
InverseViewMatrixinverseViewMatrixuniform mat4 inverseViewMatrix;
InverseProjectionMatrixinverseProjectionMatrixuniform mat4 inverseProjectionMatrix;
InverseModelViewMatrixinverseModelViewuniform mat4 inverseModelView;
InverseViewProjectionMatrixinverseViewProjectionMatrixuniform mat4 inverseViewProjectionMatrix;
InverseModelViewProjectionMatrixinverseModelViewProjektionuniform mat4 inverseModelViewProjection;
ModelNormalMatrixmodelNormalMatrixuniform mat3 modelNormalMatrix;
ModelViewNormalMatrixmodelViewNormaluniform mat3 modelViewNormal;
AnsichtsfensterMatrixAnsichtsfensterMatrixuniform mat4 viewportMatrix;
InverseViewportMatrixinverseViewportMatrixeinheitliche mat4 inverseViewportMatrix;
AspectRatio
(Breite der Oberfläche / Höhe der Oberfläche)
aspectRatiouniform float aspectRatio;
BelichtungBelichtunguniform float Belichtung;
Gammagammaeinheitliche Größe gamma;
Zeit
(in Nanosekunden)
Zeituniform float time;
AugenPositionAugenpositioneinheitlicher vec3 eyePosition;
SkinningPaletteskinningPalette[0]const int maxJoints = 100;
uniform mat4 skinningPalette[maxJoints];

RHI-Unterstützung

Beim Schreiben von GLSL 450 Shader-Code zur Verwendung mit dem RHI-Backend von Qt 3D werden die Standard-Uniformen als 2 Uniform-Buffer-Objekte bereitgestellt.

Die Bindungspositionen für diese sind auf die Bindungen 0 für RenderView-Uniformen und 1 für Command-Uniformen festgelegt.

#version 450 core

layout(location = 0) in vec3 vertexPosition;

layout(std140, binding = 0) uniform qt3d_render_view_uniforms {
  mat4 viewMatrix;
  mat4 projectionMatrix;
  mat4 uncorrectedProjectionMatrix;
  mat4 clipCorrectionMatrix;
  mat4 viewProjectionMatrix;
  mat4 inverseViewMatrix;
  mat4 inverseProjectionMatrix;
  mat4 inverseViewProjectionMatrix;
  mat4 viewportMatrix;
  mat4 inverseViewportMatrix;
  vec4 textureTransformMatrix;
  vec3 eyePosition;
  float aspectRatio;
  float gamma;
  float exposure;
  float time;
  float yUpInNDC;
  float yUpInFBO;
};

layout(std140, binding = 1) uniform qt3d_command_uniforms {
  mat4 modelMatrix;
  mat4 inverseModelMatrix;
  mat4 modelViewMatrix;
  mat3 modelNormalMatrix;
  mat4 inverseModelViewMatrix;
  mat4 modelViewProjection;
  mat4 inverseModelViewProjectionMatrix;
};

void main()
{
    gl_Position = (projectionMatrix * viewMatrix * modelMatrix * vertexPosition);
}

Für benutzerdefinierte einheitliche Pufferobjekte verwenden Sie die Bindung beginnend mit 2 oder auto, damit Qt 3D die Bindung automatisch vornehmen kann. Achten Sie darauf, dass Sie zwischen den verschiedenen Shader-Stufen konsistent bleiben.

#version 450 core

layout(std140, binding = auto) uniform my_uniforms {
  vec4 myColor;
};

layout(location=0) out vec4 fragColor;

void main()
{
    fragColor = myColor;
}

Es gibt keine Änderungen, wenn es darum geht, Werte an Uniformen zu übergeben.

Für das obige Beispiel könnte das Setzen von myColor mit erledigt werden:

QParameter *parameter = new QParameter();
parameter->setName("myColor");
parameter->setValue(QVariant::fromValue(QColor(Qt::blue)));

Texturen müssen immer noch als eigenständige Uniformen definiert werden.

#version 450 core

layout(binding=0) uniform sampler2D source;

layout(location=0) out vec4 fragColor;

void main()
{
    fragColor = texture(source, vec2(0.5, 0.5));
}

Dokumentation der Mitgliedstypen

enum QShaderProgram::Format

Diese Aufzählung gibt das Format des verwendeten Shader-Codes an.

KonstanteWertBeschreibung
Qt3DRender::QShaderProgram::GLSL0OpenGL
Qt3DRender::QShaderProgram::SPIRV1Vulkan, OpenGL 5

enum QShaderProgram::ShaderType

Diese Aufzählung identifiziert den Typ des verwendeten Shaders.

KonstanteWertBeschreibung
Qt3DRender::QShaderProgram::Vertex0Vertex-Shader
Qt3DRender::QShaderProgram::Fragment1Fragment-Shader
Qt3DRender::QShaderProgram::TessellationControl2Tesselation-Steuerungs-Shader
Qt3DRender::QShaderProgram::TessellationEvaluation3Tesselation-Auswertungs-Shader
Qt3DRender::QShaderProgram::Geometry4Geometrie-Shader
Qt3DRender::QShaderProgram::Compute5Berechnungs-Shader

enum QShaderProgram::Status

Diese Aufzählung gibt den Status des verwendeten Shaders an.

KonstanteWertBeschreibung
Qt3DRender::QShaderProgram::NotReady0Der Shader wurde noch nicht kompiliert und gelinkt
Qt3DRender::QShaderProgram::Ready1Der Shader wurde erfolgreich kompiliert
Qt3DRender::QShaderProgram::Error2Beim Kompilieren des Shaders ist ein Fehler aufgetreten

Dokumentation der Eigenschaft

computeShaderCode : QByteArray

Enthält den von diesem Shader-Programm verwendeten Compute-Shader-Code.

Zugriffsfunktionen:

QByteArray computeShaderCode() const
void setComputeShaderCode(const QByteArray &computeShaderCode)

Benachrichtigungssignal:

void computeShaderCodeChanged(const QByteArray &computeShaderCode)

format : Format

Enthält das Format des auf ShaderProgram bereitgestellten Codes. Die Standardeinstellung ist ShaderProgram. GLSL

Zugriffsfunktionen:

Qt3DRender::QShaderProgram::Format format() const
void setFormat(Qt3DRender::QShaderProgram::Format format)

Benachrichtigungssignal:

void formatChanged(Qt3DRender::QShaderProgram::Format format)

fragmentShaderCode : QByteArray

Enthält den Fragment-Shader-Code, der von diesem Shader-Programm verwendet wird.

Zugriffsfunktionen:

QByteArray fragmentShaderCode() const
void setFragmentShaderCode(const QByteArray &fragmentShaderCode)

Benachrichtigungssignal:

void fragmentShaderCodeChanged(const QByteArray &fragmentShaderCode)

geometryShaderCode : QByteArray

Enthält den von diesem Shader-Programm verwendeten Geometrie-Shader-Code.

Zugriffsfunktionen:

QByteArray geometryShaderCode() const
void setGeometryShaderCode(const QByteArray &geometryShaderCode)

Benachrichtigungssignal:

void geometryShaderCodeChanged(const QByteArray &geometryShaderCode)

[read-only] log : const QString

Enthält das Protokoll des aktuellen Shader-Programms. Dies ist nützlich, um einen Kompilierungsfehler des Shader-Programms zu diagnostizieren.

Zugriffsfunktionen:

QString log() const

Benachrichtigungssignal:

void logChanged(const QString &log)

[read-only] status : const Status

Enthält den Status des aktuellen Shaderprogramms.

Zugriffsfunktionen:

Qt3DRender::QShaderProgram::Status status() const

Benachrichtigungssignal:

void statusChanged(Qt3DRender::QShaderProgram::Status status)

tessellationControlShaderCode : QByteArray

Enthält den von diesem Shader-Programm verwendeten Shader-Code für die Tesselationssteuerung.

Zugriffsfunktionen:

QByteArray tessellationControlShaderCode() const
void setTessellationControlShaderCode(const QByteArray &tessellationControlShaderCode)

Benachrichtigungssignal:

void tessellationControlShaderCodeChanged(const QByteArray &tessellationControlShaderCode)

tessellationEvaluationShaderCode : QByteArray

Enthält den Shader-Code für die Tesselationsevaluierung, der von diesem Shader-Programm verwendet wird.

Zugriffsfunktionen:

QByteArray tessellationEvaluationShaderCode() const
void setTessellationEvaluationShaderCode(const QByteArray &tessellationEvaluationShaderCode)

Benachrichtigungssignal:

void tessellationEvaluationShaderCodeChanged(const QByteArray &tessellationEvaluationShaderCode)

vertexShaderCode : QByteArray

Enthält den von diesem Shader-Programm verwendeten Vertex-Shader-Code.

Zugriffsfunktionen:

QByteArray vertexShaderCode() const
void setVertexShaderCode(const QByteArray &vertexShaderCode)

Benachrichtigungssignal:

void vertexShaderCodeChanged(const QByteArray &vertexShaderCode)

Member Function Dokumentation

[static invokable] QByteArray QShaderProgram::loadSource(const QUrl &sourceUrl)

Gibt den von sourceUrl geladenen Shader-Code zurück.

Hinweis: Diese Funktion kann über das Meta-Objektsystem und von QML aus aufgerufen werden. Siehe Q_INVOKABLE.

void QShaderProgram::setShaderCode(Qt3DRender::QShaderProgram::ShaderType type, const QByteArray &shaderCode)

Setzt den Shader-Code für type des Shaders auf die shaderCode.

Siehe auch shaderCode().

QByteArray QShaderProgram::shaderCode(Qt3DRender::QShaderProgram::ShaderType type) const

Gibt den Shader-Code für type zurück.

Siehe auch setShaderCode().

Qt3DRender::QShaderProgram::Status QShaderProgram::status() const

Gibt den Status des aktuellen Shader-Programms zurück.

Hinweis: Getter-Funktion für die Eigenschaft status.

© 2025 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.