Qt 4.8: QGLShader Class Reference

Qt Reference Documentation

- Qt 4.8
- ALL VERSIONS

- A
- A
- A
- Print

# QGLShader Class Reference

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

     #include <QGLShader>

Inherits: QObject.

This class was introduced in Qt 4.6.

- List of all members, including inherited members

## Public Types

flags | ShaderType
enum | ShaderTypeBit { Vertex, Fragment, Geometry }

## 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

- 29 public functions inherited from QObject

## Static Public Members

bool | hasOpenGLShaders ( ShaderType type, const QGLContext * context = 0 )

- 7 static public members inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 signal inherited from QObject
- 8 protected functions inherited from QObject

## 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.

Constant | Value | Description
--- | --- | ---
`QGLShader::Vertex` | `0x0001` | Vertex shader written in the OpenGL Shading Language (GLSL).
`QGLShader::Fragment` | `0x0002` | Fragment shader written in the OpenGL Shading Language (GLSL).
`QGLShader::Geometry` | `0x0004` | Geometry shaders written in the OpenGL Shading Language (GLSL), based on the GL_EXT_geometry_shader4 extension.

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::hasOpenGLShaders ( ShaderType type, const QGLContext * context = 0 )`[static]`

Returns true if shader programs of type type are supported on this system; false otherwise.

The context is used to resolve the GLSL extensions. If context is null, then QGLContext::currentContext() is used.

This function was introduced in Qt 4.7.

### 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().