 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QOpenGLShader class allows OpenGL shaders to be compiled. More...
#include <qopenglshaderprogram.h>
Inheritance diagram for QOpenGLShader: Collaboration diagram for QOpenGLShader:Public Types | |
| enum | ShaderTypeBit { Vertex = 0x0001 , Fragment = 0x0002 , Geometry = 0x0004 , TessellationControl = 0x0008 , TessellationEvaluation = 0x0010 , Compute = 0x0020 } |
| This enum specifies the type of QOpenGLShader that is being created. More... | |
Public Member Functions | |
| QOpenGLShader (QOpenGLShader::ShaderType type, QObject *parent=nullptr) | |
| Constructs a new QOpenGLShader object of the specified type and attaches it to parent. | |
| ~QOpenGLShader () | |
| Deletes this shader. | |
| QOpenGLShader::ShaderType | shaderType () const |
| Returns the type of this shader. | |
| bool | compileSourceCode (const char *source) |
| Sets the source code for this shader and compiles it. | |
| bool | compileSourceCode (const QByteArray &source) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the source code for this shader and compiles it. | |
| bool | compileSourceCode (const QString &source) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the source code for this shader and compiles it. | |
| bool | compileSourceFile (const QString &fileName) |
| Sets the source code for this shader to the contents of fileName and compiles it. | |
| QByteArray | sourceCode () const |
| Returns the source code for this shader. | |
| bool | isCompiled () const |
Returns true if this shader has been compiled; false otherwise. | |
| QString | log () const |
| Returns the errors and warnings that occurred during the last compile. | |
| GLuint | shaderId () const |
| Returns the OpenGL identifier associated with this shader. | |
| Public Member Functions inherited from QObject | |
| Q_INVOKABLE | QObject (QObject *parent=nullptr) |
| Constructs an object with parent object parent. | |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. | |
| virtual bool | event (QEvent *event) |
| This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T > | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T > | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T > | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T > | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
| bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
| void | dumpObjectTree () const |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
Static Public Member Functions | |
| static bool | hasOpenGLShaders (ShaderType type, QOpenGLContext *context=nullptr) |
Returns true if shader programs of type type are supported on this system; false otherwise. | |
| Static Public Member Functions inherited from QObject | |
| static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
| \threadsafe | |
| static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1 , typename Func2 > | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1 , typename Func2 > | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| \threadsafe | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static bool | disconnect (const QMetaObject::Connection &) |
| Disconnect a connection. | |
| template<typename Func1 , typename Func2 > | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
| template<typename Func1 > | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
Friends | |
| class | QOpenGLShaderProgram |
Additional Inherited Members | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=nullptr) |
| This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
| void | objectNameChanged (const QString &objectName, QPrivateSignal) |
| This signal is emitted after the object's name has been changed. | |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
The QOpenGLShader class allows OpenGL shaders to be compiled.
\inmodule QtOpenGL
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.
Definition at line 23 of file qopenglshaderprogram.h.
This enum specifies the type of QOpenGLShader that is being created.
\value Vertex Vertex shader written in the OpenGL Shading Language (GLSL). \value Fragment Fragment shader written in the OpenGL Shading Language (GLSL). \value Geometry Geometry shaders written in the OpenGL Shading Language (GLSL) (requires OpenGL >= 3.2 or OpenGL ES >= 3.2). \value TessellationControl Tessellation control shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.0 or OpenGL ES >= 3.2). \value TessellationEvaluation Tessellation evaluation shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.0 or OpenGL ES >= 3.2). \value Compute Compute shaders written in the OpenGL shading language (GLSL) (requires OpenGL >= 4.3 or OpenGL ES >= 3.1).
| Enumerator | |
|---|---|
| Vertex | |
| Fragment | |
| Geometry | |
| TessellationControl | |
| TessellationEvaluation | |
| Compute | |
Definition at line 27 of file qopenglshaderprogram.h.
|
explicit |
Constructs a new QOpenGLShader object of the specified type and attaches it to parent.
If shader programs are not supported, QOpenGLShaderProgram::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.
Definition at line 410 of file qopenglshaderprogram.cpp.
| QOpenGLShader::~QOpenGLShader | ( | ) |
Deletes this shader.
If the shader has been attached to a QOpenGLShaderProgram object, then the actual shader will stay around until the QOpenGLShaderProgram is destroyed.
Definition at line 422 of file qopenglshaderprogram.cpp.
| bool QOpenGLShader::compileSourceCode | ( | const char * | source | ) |
Sets the source code for this shader and compiles it.
Returns true if the source was successfully compiled, false otherwise.
Definition at line 564 of file qopenglshaderprogram.cpp.
| bool QOpenGLShader::compileSourceCode | ( | const QByteArray & | source | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the source code for this shader and compiles it.
Returns true if the source was successfully compiled, false otherwise.
Definition at line 654 of file qopenglshaderprogram.cpp.
| bool QOpenGLShader::compileSourceCode | ( | const QString & | source | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the source code for this shader and compiles it.
Returns true if the source was successfully compiled, false otherwise.
Definition at line 667 of file qopenglshaderprogram.cpp.
| bool QOpenGLShader::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.
Definition at line 679 of file qopenglshaderprogram.cpp.
|
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 \nullptr, then QOpenGLContext::currentContext() is used.
Definition at line 3699 of file qopenglshaderprogram.cpp.
| bool QOpenGLShader::isCompiled | ( | ) | const |
Returns true if this shader has been compiled; false otherwise.
Definition at line 719 of file qopenglshaderprogram.cpp.
| QString QOpenGLShader::log | ( | ) | const |
Returns the errors and warnings that occurred during the last compile.
Definition at line 730 of file qopenglshaderprogram.cpp.
| GLuint QOpenGLShader::shaderId | ( | ) | const |
Returns the OpenGL identifier associated with this shader.
Definition at line 741 of file qopenglshaderprogram.cpp.
| QOpenGLShader::ShaderType QOpenGLShader::shaderType | ( | ) | const |
Returns the type of this shader.
Definition at line 429 of file qopenglshaderprogram.cpp.
| QByteArray QOpenGLShader::sourceCode | ( | ) | const |
Returns the source code for this shader.
Definition at line 696 of file qopenglshaderprogram.cpp.
|
friend |
Definition at line 58 of file qopenglshaderprogram.h.
1.12.0