QOpenGLShader

The QOpenGLShader class allows OpenGL shaders to be compiled. More

Inheritance diagram of PySide2.QtGui.QOpenGLShader

New in version 5.0.

Synopsis

Functions

Static functions

Detailed Description

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

QOpenGLShader and QOpenGLShaderProgram shelter the programmer from the details of compiling and linking vertex and fragment shaders.

class QOpenGLShader(type[, parent=None])
param type

ShaderType

param parent

QObject

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

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

The shader will be associated with the current QOpenGLContext .

PySide2.QtGui.QOpenGLShader.ShaderTypeBit

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

Constant

Description

QOpenGLShader.Vertex

Vertex shader written in the OpenGL Shading Language (GLSL).

QOpenGLShader.Fragment

Fragment shader written in the OpenGL Shading Language (GLSL).

QOpenGLShader.Geometry

Geometry shaders written in the OpenGL Shading Language (GLSL) (requires OpenGL >= 3.2 or OpenGL ES >= 3.2).

QOpenGLShader.TessellationControl

Tessellation control shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.0 or OpenGL ES >= 3.2).

QOpenGLShader.TessellationEvaluation

Tessellation evaluation shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.0 or OpenGL ES >= 3.2).

QOpenGLShader.Compute

Compute shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.3 or OpenGL ES >= 3.1).

PySide2.QtGui.QOpenGLShader.compileSourceCode(source)
Parameters

sourceQByteArray

Return type

bool

PySide2.QtGui.QOpenGLShader.compileSourceCode(source)
Parameters

source – unicode

Return type

bool

PySide2.QtGui.QOpenGLShader.compileSourceCode(source)
Parameters

source – str

Return type

bool

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

PySide2.QtGui.QOpenGLShader.compileSourceFile(fileName)
Parameters

fileName – unicode

Return type

bool

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.

static PySide2.QtGui.QOpenGLShader.hasOpenGLShaders(type[, context=None])
Parameters
Return type

bool

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 None , then currentContext() is used.

PySide2.QtGui.QOpenGLShader.isCompiled()
Return type

bool

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

PySide2.QtGui.QOpenGLShader.log()
Return type

unicode

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

PySide2.QtGui.QOpenGLShader.shaderId()
Return type

GLuint

Returns the OpenGL identifier associated with this shader.

See also

programId()

PySide2.QtGui.QOpenGLShader.shaderType()
Return type

ShaderType

Returns the type of this shader.

PySide2.QtGui.QOpenGLShader.sourceCode()
Return type

QByteArray

Returns the source code for this shader.