Home · All Classes · All Functions · Overviews

QGLShader Class Reference
[QtOpenGL module]

The QGLShader class allows OpenGL shaders to be compiled. More...

 #include <QGLShader>

This class is not part of the Qt GUI Framework Edition.

Inherits QObject.

This class was introduced in Qt 4.6.


Public Types

flags ShaderType
enum ShaderTypeBit { Vertex, Fragment }

Public Functions

QGLShader ( QGLShader::ShaderType type, QObject * parent = 0 )
QGLShader ( QGLShader::ShaderType type, const QGLContext * context, QObject * parent = 0 )
virtual ~QGLShader ()
bool compileSourceCode ( const char * source )
bool compileSourceCode ( const QByteArray & source )
bool compileSourceCode ( const QString & source )
bool compileSourceFile ( const QString & fileName )
bool isCompiled () const
QString log () const
GLuint shaderId () const
QGLShader::ShaderType shaderType () const
QByteArray sourceCode () const

Additional Inherited Members


Detailed Description

The QGLShader class allows OpenGL shaders to be compiled.

This class supports shaders written in the OpenGL Shading Language (GLSL) and in the OpenGL/ES Shading Language (GLSL/ES).

QGLShader and QGLShaderProgram shelter the programmer from the details of compiling and linking vertex and fragment shaders.

See also QGLShaderProgram.


Member Type Documentation

enum QGLShader::ShaderTypeBit
flags QGLShader::ShaderType

This enum specifies the type of QGLShader that is being created.

ConstantValueDescription
QGLShader::Vertex0x0001Vertex shader written in the OpenGL Shading Language (GLSL).
QGLShader::Fragment0x0002Fragment shader written in the OpenGL Shading Language (GLSL).

The ShaderType type is a typedef for QFlags<ShaderTypeBit>. It stores an OR combination of ShaderTypeBit values.


Member Function Documentation

QGLShader::QGLShader ( QGLShader::ShaderType type, QObject * parent = 0 )

Constructs a new QGLShader object of the specified type and attaches it to parent. If shader programs are not supported, QGLShaderProgram::hasOpenGLShaderPrograms() will return false.

This constructor is normally followed by a call to compileSourceCode() or compileSourceFile().

The shader will be associated with the current QGLContext.

See also compileSourceCode() and compileSourceFile().

QGLShader::QGLShader ( QGLShader::ShaderType type, const QGLContext * context, QObject * parent = 0 )

Constructs a new QGLShader object of the specified type and attaches it to parent. If shader programs are not supported, then QGLShaderProgram::hasOpenGLShaderPrograms() will return false.

This constructor is normally followed by a call to compileSourceCode() or compileSourceFile().

The shader will be associated with context.

See also compileSourceCode() and compileSourceFile().

QGLShader::~QGLShader ()   [virtual]

Deletes this shader. If the shader has been attached to a QGLShaderProgram object, then the actual shader will stay around until the QGLShaderProgram is destroyed.

bool QGLShader::compileSourceCode ( const char * source )

Sets the source code for this shader and compiles it. Returns true if the source was successfully compiled, false otherwise.

See also compileSourceFile().

bool QGLShader::compileSourceCode ( const QByteArray & source )

This is an overloaded function.

Sets the source code for this shader and compiles it. Returns true if the source was successfully compiled, false otherwise.

See also compileSourceFile().

bool QGLShader::compileSourceCode ( const QString & source )

This is an overloaded function.

Sets the source code for this shader and compiles it. Returns true if the source was successfully compiled, false otherwise.

See also compileSourceFile().

bool QGLShader::compileSourceFile ( const QString & fileName )

Sets the source code for this shader to the contents of fileName and compiles it. Returns true if the file could be opened and the source compiled, false otherwise.

See also compileSourceCode().

bool QGLShader::isCompiled () const

Returns true if this shader has been compiled; false otherwise.

See also compileSourceCode() and compileSourceFile().

QString QGLShader::log () const

Returns the errors and warnings that occurred during the last compile.

See also compileSourceCode() and compileSourceFile().

GLuint QGLShader::shaderId () const

Returns the OpenGL identifier associated with this shader.

See also QGLShaderProgram::programId().

QGLShader::ShaderType QGLShader::shaderType () const

Returns the type of this shader.

QByteArray QGLShader::sourceCode () const

Returns the source code for this shader.

See also compileSourceCode().


Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt 4.6.3