QOpenGLDebugMessage Class

The QOpenGLDebugMessage class wraps an OpenGL debug message. More...

Header: #include <QOpenGLDebugMessage>
qmake: QT += gui
Since: Qt 5.1

This class was introduced in Qt 5.1.

Note: All functions in this class are reentrant.

Public Types

flags Severities
enum Severity { InvalidSeverity, HighSeverity, MediumSeverity, LowSeverity, NotificationSeverity, AnySeverity }
enum Source { InvalidSource, APISource, WindowSystemSource, ShaderCompilerSource, ThirdPartySource, …, AnySource }
flags Sources
enum Type { InvalidType, ErrorType, DeprecatedBehaviorType, UndefinedBehaviorType, PortabilityType, …, AnyType }
flags Types

Public Functions

QOpenGLDebugMessage(const QOpenGLDebugMessage &debugMessage)
QOpenGLDebugMessage()
QOpenGLDebugMessage &operator=(QOpenGLDebugMessage &&debugMessage)
QOpenGLDebugMessage &operator=(const QOpenGLDebugMessage &debugMessage)
~QOpenGLDebugMessage()
GLuint id() const
QString message() const
QOpenGLDebugMessage::Severity severity() const
QOpenGLDebugMessage::Source source() const
void swap(QOpenGLDebugMessage &debugMessage)
QOpenGLDebugMessage::Type type() const
bool operator!=(const QOpenGLDebugMessage &debugMessage) const
bool operator==(const QOpenGLDebugMessage &debugMessage) const

Static Public Members

QOpenGLDebugMessage createApplicationMessage(const QString &text, GLuint id = 0, QOpenGLDebugMessage::Severity severity = NotificationSeverity, QOpenGLDebugMessage::Type type = OtherType)
QOpenGLDebugMessage createThirdPartyMessage(const QString &text, GLuint id = 0, QOpenGLDebugMessage::Severity severity = NotificationSeverity, QOpenGLDebugMessage::Type type = OtherType)
QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Source source)
QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Type type)
QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Severity severity)
QDebug operator<<(QDebug debug, const QOpenGLDebugMessage &message)

Detailed Description

Debug messages are usually created by the OpenGL server and then read by OpenGL clients (either from the OpenGL internal debug log, or logged in real-time). A debug message has a textual representation, a vendor-specific numeric id, a source, a type and a severity.

It's also possible for applications or third-party libraries and toolkits to create and insert messages in the debug log. In order to do so, you can use the createApplicationMessage() or the createThirdPartyMessage() static functions.

See also QOpenGLDebugLogger.

Member Type Documentation

enum QOpenGLDebugMessage::Severity
flags QOpenGLDebugMessage::Severities

The Severity enum defines the severity of the debug message.

ConstantValueDescription
QOpenGLDebugMessage::InvalidSeverity0x00000000The severity of the message is invalid; this is the severity of a default-constructed QOpenGLDebugMessage object.
QOpenGLDebugMessage::HighSeverity0x00000001The message has a high severity.
QOpenGLDebugMessage::MediumSeverity0x00000002The message has a medium severity.
QOpenGLDebugMessage::LowSeverity0x00000004The message has a low severity.
QOpenGLDebugMessage::NotificationSeverity0x00000008The message is a notification.
QOpenGLDebugMessage::AnySeverity0xffffffffThis value corresponds to a mask of all possible message severities.

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

enum QOpenGLDebugMessage::Source
flags QOpenGLDebugMessage::Sources

The Source enum defines the source of the debug message.

ConstantValueDescription
QOpenGLDebugMessage::InvalidSource0x00000000The source of the message is invalid; this is the source of a default-constructed QOpenGLDebugMessage object.
QOpenGLDebugMessage::APISource0x00000001The message was generated in response to OpenGL API calls.
QOpenGLDebugMessage::WindowSystemSource0x00000002The message was generated by the window system.
QOpenGLDebugMessage::ShaderCompilerSource0x00000004The message was generated by the shader compiler.
QOpenGLDebugMessage::ThirdPartySource0x00000008The message was generated by a third party, for instance an OpenGL framework a or debugging toolkit.
QOpenGLDebugMessage::ApplicationSource0x00000010The message was generated by the application itself.
QOpenGLDebugMessage::OtherSource0x00000020The message was generated by a source not included in this enumeration.
QOpenGLDebugMessage::AnySource0xffffffffThis value corresponds to a mask of all possible message sources.

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

enum QOpenGLDebugMessage::Type
flags QOpenGLDebugMessage::Types

The Type enum defines the type of the debug message.

ConstantValueDescription
QOpenGLDebugMessage::InvalidType0x00000000The type of the message is invalid; this is the type of a default-constructed QOpenGLDebugMessage object.
QOpenGLDebugMessage::ErrorType0x00000001The message represents an error.
QOpenGLDebugMessage::DeprecatedBehaviorType0x00000002The message represents an usage of deprecated behavior.
QOpenGLDebugMessage::UndefinedBehaviorType0x00000004The message represents an usage of undefined behavior.
QOpenGLDebugMessage::PortabilityType0x00000008The message represents an usage of vendor-specific behavior, that might pose portability concerns.
QOpenGLDebugMessage::PerformanceType0x00000010The message represents a performance issue.
QOpenGLDebugMessage::OtherType0x00000020The message represents a type not included in this enumeration.
QOpenGLDebugMessage::MarkerType0x00000040The message represents a marker in the debug log.
QOpenGLDebugMessage::GroupPushType0x00000080The message represents a debug group push operation.
QOpenGLDebugMessage::GroupPopType0x00000100The message represents a debug group pop operation.
QOpenGLDebugMessage::AnyType0xffffffffThis value corresponds to a mask of all possible message types.

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

Member Function Documentation

QOpenGLDebugMessage::QOpenGLDebugMessage(const QOpenGLDebugMessage &debugMessage)

Constructs a debug message as a copy of debugMessage.

See also operator=().

QOpenGLDebugMessage::QOpenGLDebugMessage()

Constructs a debug message with an empty message string, id set to 0, source set to InvalidSource, type set to InvalidType, and severity set to InvalidSeverity.

Note: This constructor should not be used to create a debug message; instead, use the createApplicationMessage() or the createThirdPartyMessage() static functions.

See also createApplicationMessage() and createThirdPartyMessage().

QOpenGLDebugMessage &QOpenGLDebugMessage::operator=(QOpenGLDebugMessage &&debugMessage)

Move-assigns debugMessage to this object.

QOpenGLDebugMessage &QOpenGLDebugMessage::operator=(const QOpenGLDebugMessage &debugMessage)

Assigns the message debugMessage to this object, and returns a reference to the copy.

QOpenGLDebugMessage::~QOpenGLDebugMessage()

Destroys this debug message.

[static] QOpenGLDebugMessage QOpenGLDebugMessage::createApplicationMessage(const QString &text, GLuint id = 0, QOpenGLDebugMessage::Severity severity = NotificationSeverity, QOpenGLDebugMessage::Type type = OtherType)

Constructs and returns a debug message with text as its text, id as id, severity as severity, and type as type. The message source will be set to ApplicationSource.

See also QOpenGLDebugLogger::logMessage() and createThirdPartyMessage().

[static] QOpenGLDebugMessage QOpenGLDebugMessage::createThirdPartyMessage(const QString &text, GLuint id = 0, QOpenGLDebugMessage::Severity severity = NotificationSeverity, QOpenGLDebugMessage::Type type = OtherType)

Constructs and returns a debug message with text as its text, id as id, severity as severity, and type as type. The message source will be set to ThirdPartySource.

See also QOpenGLDebugLogger::logMessage() and createApplicationMessage().

GLuint QOpenGLDebugMessage::id() const

Returns the id of the debug message. Ids are generally vendor-specific.

QString QOpenGLDebugMessage::message() const

Returns the textual message contained by this debug message.

QOpenGLDebugMessage::Severity QOpenGLDebugMessage::severity() const

Returns the severity of the debug message.

QOpenGLDebugMessage::Source QOpenGLDebugMessage::source() const

Returns the source of the debug message.

void QOpenGLDebugMessage::swap(QOpenGLDebugMessage &debugMessage)

Swaps the message debugMessage with this message. This operation is very fast and never fails.

QOpenGLDebugMessage::Type QOpenGLDebugMessage::type() const

Returns the type of the debug message.

bool QOpenGLDebugMessage::operator!=(const QOpenGLDebugMessage &debugMessage) const

Returns true if this message is different from debugMessage, or false otherwise.

See also operator==().

bool QOpenGLDebugMessage::operator==(const QOpenGLDebugMessage &debugMessage) const

Returns true if this debug message is equal to debugMessage, or false otherwise. Two debugging messages are equal if they have the same textual message, the same id, the same source, the same type and the same severity.

See also operator!=().

Related Non-Members

QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Source source)

Writes the source source into the debug object debug for debugging purposes.

QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Type type)

Writes the type type into the debug object debug for debugging purposes.

QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Severity severity)

Writes the severity severity into the debug object debug for debugging purposes.

QDebug operator<<(QDebug debug, const QOpenGLDebugMessage &message)

Writes the message message into the debug object debug for debugging purposes.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.