QShaderProgram Class

(Qt3DRender::QShaderProgram)

Encapsulates a Shader Program. More...

Header:	#include <QShaderProgram>
qmake:	QT += 3drender
Since:	Qt 5.5
Instantiated By:	ShaderProgram
Inherits:	Qt3DCore::QNode

This class was introduced in Qt 5.5.

• List of all members, including inherited members

Public Types

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

Properties

computeShaderCode : QByteArray fragmentShaderCode : QByteArray geometryShaderCode : QByteArray log : const QString

status : const Status tessellationControlShaderCode : QByteArray tessellationEvaluationShaderCode : QByteArray vertexShaderCode : QByteArray

Public Functions

QByteArray	computeShaderCode() const
QByteArray	fragmentShaderCode() const
QByteArray	geometryShaderCode() const
QString	log() const
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

Public 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)

Signals

void	computeShaderCodeChanged(const QByteArray &computeShaderCode)
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)

Static Public Members

QByteArray

loadSource(const QUrl &sourceUrl)

Reimplemented Protected Functions

virtual void

sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override

Detailed Description

A shader program consists of several different shaders, such as vertex and fragment shaders.

Qt3D will automatically populate a set of default uniforms if they are encountered during the shader instrospection phase.

Default Uniform	Associated Qt3D Parameter name		GLSL declaration
ModelMatrix	modelMatrix		uniform mat4 modelMatrix;
ViewMatrix	viewMatrix		uniform mat4 viewMatrix;
ProjectionMatrix	projectionMatrix		uniform mat4 projectionMatrix;
ModelViewMatrix	modelView		uniform mat4 modelView;
ViewProjectionMatrix	viewProjectionMatrix		uniform mat4 viewProjectionMatrix;
ModelViewProjectionMatrix	modelViewProjection mvp		uniform mat4 modelViewProjection; uniform mat4 mvp;
InverseModelMatrix	inverseModelMatrix		uniform mat4 inverseModelMatrix;
InverseViewMatrix	inverseViewMatrix		uniform mat4 inverseViewMatrix;
InverseProjectionMatrix	inverseProjectionMatrix		uniform mat4 inverseProjectionMatrix;
InverseModelViewMatrix	inverseModelView		uniform mat4 inverseModelView;
InverseViewProjectionMatrix	inverseViewProjectionMatrix		uniform mat4 inverseViewProjectionMatrix;
InverseModelViewProjectionMatrix	inverseModelViewProjection		uniform mat4 inverseModelViewProjection;
ModelNormalMatrix	modelNormalMatrix		uniform mat3 modelNormalMatrix;
ModelViewNormalMatrix	modelViewNormal		uniform mat3 modelViewNormal;
ViewportMatrix	viewportMatrix		uniform mat4 viewportMatrix;
InverseViewportMatrix	inverseViewportMatrix		uniform mat4 inverseViewportMatrix;
AspectRatio (surface width / surface height)	aspectRatio		uniform float aspectRatio;
Exposure	exposure		uniform float exposure;
Gamma	gamma		uniform float gamma;
Time (in nano seconds)	time		uniform float time;
EyePosition	eyePosition		uniform vec3 eyePosition;
SkinningPalette	skinningPalette[0]		const int maxJoints = 100; uniform mat4 skinningPalette[maxJoints];

Member Type Documentation

enum QShaderProgram::ShaderType

This enum identifies the type of shader used.

Constant	Value	Description
Qt3DRender::QShaderProgram::Vertex	0	Vertex shader
Qt3DRender::QShaderProgram::Fragment	1	Fragment shader
Qt3DRender::QShaderProgram::TessellationControl	2	Tesselation control shader
Qt3DRender::QShaderProgram::TessellationEvaluation	3	Tesselation evaluation shader
Qt3DRender::QShaderProgram::Geometry	4	Geometry shader
Qt3DRender::QShaderProgram::Compute	5	Compute shader

enum QShaderProgram::Status

This enum identifies the status of shader used.

Constant	Value	Description
Qt3DRender::QShaderProgram::NotReady	0	The shader hasn't been compiled and linked yet
Qt3DRender::QShaderProgram::Ready	1	The shader was successfully compiled
Qt3DRender::QShaderProgram::Error	2	An error occurred while compiling the shader

Member Function Documentation

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

Returns the shader code loaded from sourceUrl.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[override virtual protected] void QShaderProgram::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)

Reimplements: QNode::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change).

Posts a scene change with parameter change.

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

Sets the shader code for type of shader to the shaderCode.

See also shaderCode().

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

Returns the shader code for type.

See also setShaderCode().

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

Returns the status of the current shader program.

Note: Getter function for property status.