PySide6.QtOpenGL.QOpenGLDebugLogger

class QOpenGLDebugLogger

The QOpenGLDebugLogger enables logging of OpenGL debugging messages. More…

Inheritance diagram of PySide6.QtOpenGL.QOpenGLDebugLogger

Synopsis

Properties

Methods

Slots

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Introduction

OpenGL programming can be very error prone. Most of the time, a single failing call to OpenGL can cause an entire portion of an application to stop working, with nothing being drawn on the screen.

The only way to be sure that no errors are being returned from the OpenGL implementation is checking with glGetError after each and every API call. Moreover, OpenGL errors stack up, therefore glGetError should always be used in a loop like this:

error = GL_NO_ERROR()
do {
    error = glGetError()
    if error != GL_NO_ERROR:
        # handle the error

} while (error != GL_NO_ERROR)

If you try to clear the error stack, make sure not just keep going until GL_NO_ERROR is returned but also break on GL_CONTEXT_LOST as that error value will keep repeating.

There are also many other information we are interested in (as application developers), for instance performance issues, or warnings about using deprecated APIs. Those kind of messages are not reported through the ordinary OpenGL error reporting mechanisms.

QOpenGLDebugLogger aims at addressing these issues by providing access to the OpenGL debug log. If your OpenGL implementation supports it (by exposing the GL_KHR_debug extension), messages from the OpenGL server will be either logged in an internal OpenGL log, or passed in “real-time” to listeners as they’re generated from OpenGL.

QOpenGLDebugLogger supports both these modes of operation. Refer to the following sections to find out the differences between them.

Creating an OpenGL Debug Context

For efficiency reasons, OpenGL implementations are allowed not to create any debug output at all, unless the OpenGL context is a debug context. In order to create a debug context from Qt, you must set the QSurfaceFormat::DebugContext format option on the QSurfaceFormat used to create the QOpenGLContext object:

format = QSurfaceFormat()
# asks for a OpenGL 3.2 debug context using the Core profile
format.setMajorVersion(3)
format.setMinorVersion(2)
format.setProfile(QSurfaceFormat.CoreProfile)
format.setOption(QSurfaceFormat.DebugContext)
context = QOpenGLContext()
context.setFormat(format)
context.create()

Note that requesting a 3.2 OpenGL Core Profile is just for the example’s purposes; this class is not tied to any specific OpenGL or OpenGL ES version, as it relies on the availability of the GL_KHR_debug extension (see below).

Creating and Initializing a QOpenGLDebugLogger

QOpenGLDebugLogger is a simple QObject-derived class. Just like all QObject subclasses, you create an instance (and optionally specify a parent object), and like the other OpenGL functions in Qt you must initialize it before usage by calling initialize() whilst there is a current OpenGL context:

ctx = QOpenGLContext.currentContext()
logger = QOpenGLDebugLogger(self)
logger.initialize() # initializes in the current context, i.e. ctx

Note that the GL_KHR_debug extension must be available in the context in order to access the messages logged by OpenGL. You can check the presence of this extension by calling:

ctx.hasExtension(QByteArrayLiteral("GL_KHR_debug"))

where ctx is a valid QOpenGLContext. If the extension is not available, initialize() will return false.

Reading the Internal OpenGL Debug Log

OpenGL implementations keep an internal log of debug messages. Messages stored in this log can be retrieved by using the loggedMessages() function:

messages = logger.loggedMessages()
for message in messages:
    print(message)

The internal log has a limited size; when it fills up, older messages will get discarded to make room for the new incoming messages. When you call loggedMessages() , the internal log will be emptied as well.

If you want to be sure not to lose any debug message, you must use real-time logging instead of calling this function. However, debug messages might still be generated in the timespan between context creation and activation of real-time logging (or, in general, when the real-time logging is disabled).

Real-time logging of messages

It is also possible to receive a stream of debug messages from the OpenGL server as they are generated by the implementation. In order to do so, you need to connect a suitable slot to the messageLogged() signal, and start logging by calling startLogging() :

logger.messageLogged.connect(receiver.handleLoggedMessage)
logger.startLogging()

Similarly, logging can be disabled at any time by calling the stopLogging() function.

Real-time logging can be either asynchronous or synchronous, depending on the parameter passed to startLogging() . When logging in asynchronous mode (the default, as it has a very small overhead), the OpenGL implementation can generate messages at any time, and/or in an order which is different from the order of the OpenGL commands which caused those messages to be logged. The messages could also be generated from a thread that it’s different from the thread the context is currently bound to. This is because OpenGL implementations are usually highly threaded and asynchronous, and therefore no warranties are made about the relative order and the timings of the debug messages.

On the other hand, logging in synchronous mode has a high overhead, but the OpenGL implementation guarantees that all the messages caused by a certain command are received in order, before the command returns, and from the same thread the OpenGL context is bound to.

This means that when logging in synchronous mode you will be able to run your OpenGL application in a debugger, put a breakpoint on a slot connected to the messageLogged() signal, and see in the backtrace the exact call that caused the logged message. This can be extremely useful to debug an OpenGL problem. Note that if OpenGL rendering is happening in another thread, you must force the signal/slot connection type to Qt::DirectConnection in order to be able to see the actual backtrace.

Refer to the LoggingMode enum documentation for more information about logging modes.

Note

When real-time logging is enabled, debug messages will not be inserted in the internal OpenGL debug log any more; messages already present in the internal log will not be deleted, nor they will be emitted through the messageLogged() signal. Since some messages might be generated before real-time logging is started (and therefore be kept in the internal OpenGL log), it is important to always check if it contains any message after calling startLogging() .

Inserting Messages in the Debug Log

It is possible for applications and libraries to insert custom messages in the debug log, for instance for marking a group of related OpenGL commands and therefore being then able to identify eventual messages coming from them.

In order to do so, you can create a QOpenGLDebugMessage object by calling createApplicationMessage() or createThirdPartyMessage() , and then inserting it into the log by calling logMessage() :

message =
    QOpenGLDebugMessage.createApplicationMessage("Custom message")
logger.logMessage(message)

Note that OpenGL implementations have a vendor-specific limit to the length of the messages that can be inserted in the debug log. You can retrieve this length by calling the maximumMessageLength() method; messages longer than the limit will automatically get truncated.

Controlling the Debug Output

QOpenGLDebugMessage is also able to apply filters to the debug messages, and therefore limit the amount of messages logged. You can enable or disable logging of messages by calling enableMessages() and disableMessages() respectively. By default, all messages are logged.

It is possible to enable or disable messages by selecting them by:

  • source, type and severity (and including all ids in the selection);

  • id, source and type (and including all severities in the selection).

Note that the “enabled” status for a given message is a property of the (id, source, type, severity) tuple; the message attributes do not form a hierarchy of any kind. You should be careful about the order of the calls to enableMessages() and disableMessages() , as it will change which messages will are enabled / disabled.

It’s not possible to filter by the message text itself; applications have to do that on their own (in slots connected to the messageLogged() signal, or after fetching the messages in the internal debug log through loggedMessages() ).

In order to simplify the management of the enabled / disabled statuses, QOpenGLDebugMessage also supports the concept of debug groups. A debug group contains the group of enabled / disabled configurations of debug messages. Moreover, debug groups are organized in a stack: it is possible to push and pop groups by calling pushGroup() and popGroup() respectively. (When an OpenGL context is created, there is already a group in the stack).

The enableMessages() and disableMessages() functions will modify the configuration in the current debug group, that is, the one at the top of the debug groups stack.

When a new group is pushed onto the debug groups stack, it will inherit the configuration of the group that was previously on the top of the stack. Vice versa, popping a debug group will restore the configuration of the debug group that becomes the new top.

Pushing (respectively popping) debug groups will also automatically generate a debug message of type GroupPushType (respectively GroupPopType ).

class LoggingMode

The LoggingMode enum defines the logging mode of the logger object.

Constant

Description

QOpenGLDebugLogger.AsynchronousLogging

Messages from the OpenGL server are logged asynchronously. This means that messages can be logged some time after the corresponding OpenGL actions that caused them, and even be received in an out-of-order fashion, depending on the OpenGL implementation. This mode has a very low performance penalty, as OpenGL implementations are heavily threaded and asynchronous by nature.

QOpenGLDebugLogger.SynchronousLogging

Messages from the OpenGL server are logged synchronously and sequentially. This has a severe performance hit, as OpenGL implementations are very asynchronous by nature; but it’s very useful to debug OpenGL problems, as OpenGL guarantees that the messages generated by a OpenGL command will be logged before the corresponding command execution has returned. Therefore, you can install a breakpoint on the messageLogged() signal and see in the backtrace which OpenGL command caused it; the only caveat is that if you are using OpenGL from multiple threads you may need to force direct connection when connecting to the messageLogged() signal.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property loggingModeᅟ: QOpenGLDebugLogger.LoggingMode

This property holds the logging mode passed to startLogging() ..

Note that logging must have been started or the value of this property will be meaningless.

Access functions:
__init__([parent=None])
Parameters:

parent – QObject

Constructs a new logger object with the given parent.

Note

The object must be initialized before logging can happen.

See also

initialize()

disableMessages([sources=QOpenGLDebugMessage.AnySource[, types=QOpenGLDebugMessage.AnyType[, severities=QOpenGLDebugMessage.AnySeverity]]])
Parameters:

  • sources – Combination of Source

  • types – Combination of Type

  • severities – Combination of Severity

Disables the logging of messages with the given sources, of the given types and with the given severities and any message id.

The logging will be disabled in the current control group.

disableMessages(ids[, sources=QOpenGLDebugMessage.AnySource[, types=QOpenGLDebugMessage.AnyType]])
Parameters:

  • ids – .list of unsigned int

  • sources – Combination of Source

  • types – Combination of Type

enableMessages([sources=QOpenGLDebugMessage.AnySource[, types=QOpenGLDebugMessage.AnyType[, severities=QOpenGLDebugMessage.AnySeverity]]])
Parameters:

  • sources – Combination of Source

  • types – Combination of Type

  • severities – Combination of Severity

Enables the logging of messages from the given sources, of the given types and with the given severities and any message id.

The logging will be enabled in the current control group.

enableMessages(ids[, sources=QOpenGLDebugMessage.AnySource[, types=QOpenGLDebugMessage.AnyType]])
Parameters:

  • ids – .list of unsigned int

  • sources – Combination of Source

  • types – Combination of Type

initialize()
Return type:

bool

Initializes the object in the current OpenGL context. The context must support the GL_KHR_debug extension for the initialization to succeed. The object must be initialized before any logging can happen.

It is safe to call this function multiple times from the same context.

This function can also be used to change the context of a previously initialized object; note that in this case the object must not be logging when you call this function.

Returns true if the logger is successfully initialized; false otherwise.

See also

QOpenGLContext

isLogging()
Return type:

bool

Returns true if this object is currently logging, false otherwise.

See also

startLogging()

logMessage(debugMessage)
Parameters:

debugMessage – QOpenGLDebugMessage

Inserts the message debugMessage into the OpenGL debug log. This provides a way for applications or libraries to insert custom messages that can ease the debugging of OpenGL applications.

Note

debugMessage must have ApplicationSource or ThirdPartySource as its source, and a valid type and severity, otherwise it will not be inserted into the log.

Note

The object must be initialized before logging can happen.

See also

initialize()

loggedMessages()
Return type:

.list of QOpenGLDebugMessage

Reads all the available messages in the OpenGL internal debug log and returns them. Moreover, this function will clear the internal debug log, so that subsequent invocations will not return messages that were already returned.

See also

startLogging()

loggingMode()
Return type:

LoggingMode

Returns the logging mode of the object.

See also

startLogging()

Getter of property loggingModeᅟ .

maximumMessageLength()
Return type:

int

Returns the maximum supported length, in bytes, for the text of the messages passed to logMessage() . This is also the maximum length of a debug group name, as pushing or popping groups will automatically log a message with the debug group name as the message text.

If a message text is too long, it will be automatically truncated by QOpenGLDebugLogger .

Note

Message texts are encoded in UTF-8 when they get passed to OpenGL, so their size in bytes does not usually match the amount of UTF-16 code units, as returned, for instance, by QString::length(). (It does if the message contains 7-bit ASCII only data, which is typical for debug messages.)

messageLogged(debugMessage)
Parameters:

debugMessage – QOpenGLDebugMessage

This signal is emitted when a debug message (wrapped by the debugMessage argument) is logged from the OpenGL server.

Depending on the OpenGL implementation, this signal can be emitted from other threads than the one(s) the receiver(s) lives in, and even different from the thread the QOpenGLContext in which this object has been initialized lives in. Moreover, the signal could be emitted from multiple threads at the same time. This is normally not a problem, as Qt will utilize a queued connection for cross-thread signal emissions, but if you force the connection type to Direct then you must be aware of the potential races in the slots connected to this signal.

If logging have been started in SynchronousLogging mode, OpenGL guarantees that this signal will be emitted from the same thread the QOpenGLContext has been bound to, and no concurrent invocations will ever happen.

Note

Logging must have been started, or this signal will not be emitted.

See also

startLogging()

popGroup()

Pops the topmost debug group from the debug groups stack. If the group is successfully popped, OpenGL will automatically log a message with message, id and source matching those of the popped group, type GroupPopType and severity NotificationSeverity .

Popping a debug group will restore the message filtering settings of the group that becomes the top of the debug groups stack.

Note

The object must be initialized before managing debug groups.

See also

pushGroup()

pushGroup(name[, id=0[, source=QOpenGLDebugMessage.ApplicationSource]])
Parameters:

  • name – str

  • id – int

  • source – Source

Pushes a debug group with name name, id id, and source source onto the debug groups stack. If the group is successfully pushed, OpenGL will automatically log a message with message name, id id, source source, type GroupPushType and severity NotificationSeverity .

The newly pushed group will inherit the same filtering settings of the group that was on the top of the stack; that is, the filtering will not be changed by pushing a new group.

Note

The source must either be ApplicationSource or ThirdPartySource , otherwise the group will not be pushed.

Note

The object must be initialized before managing debug groups.

See also

popGroup() enableMessages() disableMessages()

startLogging([loggingMode=QOpenGLDebugLogger.LoggingMode.AsynchronousLogging])
Parameters:

loggingMode – LoggingMode

Starts logging messages coming from the OpenGL server. When a new message is received, the signal messageLogged() is emitted, carrying the logged message as argument.

loggingMode specifies whether the logging must be asynchronous (the default) or synchronous.

QOpenGLDebugLogger will record the values of GL_DEBUG_OUTPUT and GL_DEBUG_OUTPUT_SYNCHRONOUS when logging is started, and set them back when logging is stopped. Moreover, any user-defined OpenGL debug callback installed when this function is invoked will be restored when logging is stopped; QOpenGLDebugLogger will ensure that the pre-existing callback will still be invoked when logging.

Note

It’s not possible to change the logging mode without stopping and starting logging again. This might change in a future version of Qt.

Note

The object must be initialized before logging can happen.

See also

stopLogging() initialize()

stopLogging()

Stops logging messages from the OpenGL server.

See also

startLogging()