QOpenGLDebugLogger Class

GLenum error = GL_NO_ERROR;
do {
    error = glGetError();
    if (error != GL_NO_ERROR) {
        // handle the error
    }
} while (error != GL_NO_ERROR);

QSurfaceFormat format;
// 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);

QOpenGLContext *context = new QOpenGLContext;
context->setFormat(format);
context->create();

QOpenGLContext *ctx = QOpenGLContext::currentContext();
QOpenGLDebugLogger *logger = new QOpenGLDebugLogger(this);

logger->initialize(); // initializes in the current context, i.e. ctx

ctx->hasExtension(QByteArrayLiteral("GL_KHR_debug"));

constQList<QOpenGLDebugMessage>messages= logger->loggedMessages();
for(constQOpenGLDebugMessage&message: messages)
    qDebug() << message;

connect(logger, &QOpenGLDebugLogger::messageLogged, receiver, &LogHandler::handleLoggedMessage);
logger->startLogging();

QOpenGLDebugMessage message =
    QOpenGLDebugMessage::createApplicationMessage(QStringLiteral("Custom message"));

logger->logMessage(message);

成员函数文档

[explicit] QOpenGLDebugLogger::QOpenGLDebugLogger(QObject *parent = nullptr)

使用给定的parent 构建一个新的日志记录器对象。

另请参阅 initialize()。

[virtual noexcept] QOpenGLDebugLogger::~QOpenGLDebugLogger()

销毁日志记录器对象。

void QOpenGLDebugLogger::disableMessages(QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource, QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType, QOpenGLDebugMessage::Severities severities = QOpenGLDebugMessage::AnySeverity)

禁用包含指定sources 、指定types 以及指定severities 的消息的日志记录，无论其消息ID为何。

将在当前控制组中禁用日志记录。

另请参阅 enableMessages()、pushGroup() 和popGroup()。

void QOpenGLDebugLogger::disableMessages(const QList<GLuint> &ids, QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource, QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType)

禁用对具有指定ids 的消息的日志记录，这些消息来自指定sources ，且具有指定types ，无论其严重性如何。

当前控制组中的日志记录将被禁用。

另请参阅 enableMessages()、pushGroup() 和popGroup()。

void QOpenGLDebugLogger::enableMessages(QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource, QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType, QOpenGLDebugMessage::Severities severities = QOpenGLDebugMessage::AnySeverity)

启用对来自指定sources 、指定types 、指定severities 以及任何消息ID的消息的日志记录。

将在当前控制组中启用日志记录。

另请参阅 disableMessages()、pushGroup() 和popGroup()。

void QOpenGLDebugLogger::enableMessages(const QList<GLuint> &ids, QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource, QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType)

启用对具有指定ids 的消息的日志记录，这些消息来自指定的sources ，并包含指定的types ，且不限严重性级别。

将在当前控制组中启用日志记录。

另请参阅 disableMessages()、pushGroup() 和popGroup()。

bool QOpenGLDebugLogger::initialize()

在当前的 OpenGL 上下文中初始化该对象。要使初始化成功，该上下文必须支持GL_KHR_debug 扩展。在进行任何日志记录之前，必须先初始化该对象。

在同一上下文中多次调用此函数是安全的。

此函数也可用于更改先前已初始化对象的上下文；请注意，在此情况下，调用此函数时该对象不得正在进行日志记录。

如果日志器初始化成功，则返回true ；否则返回false。

另请参阅 QOpenGLContext 。

bool QOpenGLDebugLogger::isLogging() const

如果该对象当前正在记录日志，则返回 `true `；否则返回 `false`。

另请参阅 startLogging()。

[slot] void QOpenGLDebugLogger::logMessage(const QOpenGLDebugMessage &debugMessage)

将消息debugMessage 插入到 OpenGL 调试日志中。这为应用程序或库提供了一种插入自定义消息的方式，有助于简化 OpenGL 应用程序的调试工作。

另请参阅 initialize()。

QList<QOpenGLDebugMessage> QOpenGLDebugLogger::loggedMessages() const

读取 OpenGL 内部调试日志中所有可用的消息并返回它们。此外，该函数会清空内部调试日志，以确保后续调用不会返回已经返回过的消息。

另请参阅 startLogging()。

QOpenGLDebugLogger::LoggingMode QOpenGLDebugLogger::loggingMode() const

返回该对象的日志记录模式。

另请参阅 startLogging()。

qint64 QOpenGLDebugLogger::maximumMessageLength() const

返回传递给logMessage() 的消息正文所支持的最大长度（以字节为单位）。这也是调试组名的最大长度，因为在添加或移除组时，系统会自动记录一条消息，其消息正文即为该调试组名。

如果消息文本过长，QOpenGLDebugLogger 会自动对其进行截断。

[signal] void QOpenGLDebugLogger::messageLogged(const QOpenGLDebugMessage &debugMessage)

当从 OpenGL 服务器记录一条调试消息（由 `debugMessage ` 参数封装）时，会发出此信号。

根据 OpenGL 的实现情况，该信号可能由接收者所在线程以外的其他线程发出，甚至可能与初始化该对象的QOpenGLContext 所在的线程不同。 此外，该信号可能由多个线程同时发出。这通常不会造成问题，因为 Qt 会使用队列连接来处理跨线程信号发送，但如果你将连接类型强制设为 Direct，则必须注意连接到该信号的槽中可能出现的竞争条件。

如果已在SynchronousLogging 模式下启动日志记录，OpenGL保证该信号将从QOpenGLContext 所绑定的同一线程发出，且绝不会发生并发调用。

另请参阅 startLogging()。

void QOpenGLDebugLogger::popGroup()

从调试组栈中弹出最顶层的调试组。如果成功弹出该组，OpenGL 将自动记录一条日志消息，其中 message、id 和 source 与被弹出的组对应，type 为QOpenGLDebugMessage::GroupPopType ，severity 为QOpenGLDebugMessage::NotificationSeverity 。

弹出一个调试组将恢复该调试组的消息过滤设置，该组将成为调试组栈的顶部。

另请参阅 pushGroup()。

void QOpenGLDebugLogger::pushGroup(const QString &name, GLuint id = 0, QOpenGLDebugMessage::Source source = QOpenGLDebugMessage::ApplicationSource)

将名称为name 、ID为id 、来源为source 的调试组压入调试组栈。如果该组成功压入，OpenGL将自动记录一条日志，其消息内容为name ，ID为id ，来源为source ，类型为QOpenGLDebugMessage::GroupPushType ，严重性为QOpenGLDebugMessage::NotificationSeverity 。

新压入的组将继承栈顶组的相同过滤设置；也就是说，压入新组不会改变过滤设置。

另请参阅 popGroup()、enableMessages() 和disableMessages()。

[slot] void QOpenGLDebugLogger::startLogging(QOpenGLDebugLogger::LoggingMode loggingMode = AsynchronousLogging)

开始记录来自 OpenGL 服务器的消息。当接收到新消息时，会发出messageLogged() 信号，并将记录的消息作为参数传递。

loggingMode 指定日志记录应为异步（默认）还是同步。

QOpenGLDebugLogger 将在日志记录开始时记录GL_DEBUG_OUTPUT 和GL_DEBUG_OUTPUT_SYNCHRONOUS 的值，并在日志记录停止时将其恢复。此外，调用此函数时安装的任何用户定义的 OpenGL 调试回调，将在日志记录停止时恢复；QOpenGLDebugLogger 将确保在日志记录期间仍会调用原有的回调。

另请参阅 stopLogging() 和initialize()。

[slot] void QOpenGLDebugLogger::stopLogging()

停止记录来自 OpenGL 服务器的消息。

另请参阅 startLogging()。