QShaderProgram Class

( Qt3DRender::QShaderProgram )

Encapsulates a Shader Program. 更多...

头: #include <QShaderProgram>
qmake: QT += 3drender
Since: Qt 5.5
实例化: ShaderProgram
继承: Qt3DCore::QNode

公共类型

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

特性

公共函数

QShaderProgram (Qt3DCore::QNode * parent = nullptr)
~QShaderProgram ()
QByteArray computeShaderCode () const
QByteArray fragmentShaderCode () const
QByteArray geometryShaderCode () const
QString log () const
void setShaderCode (ShaderType type , const QByteArray & shaderCode )
QByteArray shaderCode (ShaderType type ) const
Status status () const
QByteArray tessellationControlShaderCode () const
QByteArray tessellationEvaluationShaderCode () const
QByteArray vertexShaderCode () const

公共槽

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 )

信号

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

静态公共成员

QByteArray loadSource (const QUrl & sourceUrl )

保护函数

QShaderProgram (QShaderProgramPrivate & dd , Qt3DCore::QNode * parent = nullptr)
void sceneChangeEvent (const Qt3DCore::QSceneChangePtr & change )

详细描述

Encapsulates a Shader Program.

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

成员类型文档编制

enum QShaderProgram:: ShaderType

This enum identifies the type of shader used.

常量 描述
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.

常量 描述
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

特性文档编制

computeShaderCode : QByteArray

Holds the compute shader code used by this shader program.

访问函数:

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

通知程序信号:

void computeShaderCodeChanged (const QByteArray & computeShaderCode )

fragmentShaderCode : QByteArray

Holds the fragment shader code used by this shader program.

访问函数:

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

通知程序信号:

void fragmentShaderCodeChanged (const QByteArray & fragmentShaderCode )

geometryShaderCode : QByteArray

Holds the geometry shader code used by this shader program.

访问函数:

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

通知程序信号:

void geometryShaderCodeChanged (const QByteArray & geometryShaderCode )

log : const QString

Holds the log of the current shader program. This is useful to diagnose a compilation failure of the shader program.

访问函数:

QString log () const

通知程序信号:

void logChanged (const QString & log )

status : const Status

Holds the status of the current shader program.

访问函数:

Status status () const

通知程序信号:

void statusChanged (Status status )

tessellationControlShaderCode : QByteArray

Holds the tesselation control shader code used by this shader program.

访问函数:

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

通知程序信号:

void tessellationControlShaderCodeChanged (const QByteArray & tessellationControlShaderCode )

tessellationEvaluationShaderCode : QByteArray

Holds the tesselation evaluation shader code used by this shader program.

访问函数:

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

通知程序信号:

void tessellationEvaluationShaderCodeChanged (const QByteArray & tessellationEvaluationShaderCode )

vertexShaderCode : QByteArray

Holds the vertex shader code used by this shader program.

访问函数:

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

通知程序信号:

void vertexShaderCodeChanged (const QByteArray & vertexShaderCode )

成员函数文档编制

QShaderProgram:: QShaderProgram ( Qt3DCore::QNode * parent = nullptr)

Default constructs an instance of QShaderProgram.

[protected] QShaderProgram:: QShaderProgram ( QShaderProgramPrivate & dd , Qt3DCore::QNode * parent = nullptr)

Copy constructor.

QShaderProgram:: ~QShaderProgram ()

Destroys the instance of QShaderProgram.

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

Returns the shader code loaded from sourceUrl .

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

Posts a scene change with parameter change .

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

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

另请参阅 shaderCode ().

QByteArray QShaderProgram:: shaderCode ( ShaderType type ) const

Returns the shader code for type .

另请参阅 setShaderCode ().

Status QShaderProgram:: status () const

Returns the status of the current shader program.

注意: Getter 函数对于特性 status .