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"));

常量QList<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 会使用队列连接来实现跨线程信号发射，但如果强制连接类型为直接，则必须注意连接到该信号的插槽中的潜在竞赛。

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

另请参阅 startLogging().

void QOpenGLDebugLogger::popGroup()

从调试组堆栈中弹出最上面的调试组。如果该组被成功弹出，OpenGL 将自动记录一条信息，其信息、id 和来源与弹出组匹配，类型为QOpenGLDebugMessage::GroupPopType ，严重性为QOpenGLDebugMessage::NotificationSeverity 。

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

另请参见 pushGroup()。

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

将名称为name 、id 为id 、源为source 的调试组推送到调试组栈。如果该组被成功推送，OpenGL 将自动记录一条信息，信息内容为name, idid, sourcesource, typeQOpenGLDebugMessage::GroupPushType, severityQOpenGLDebugMessage::NotificationSeverity 。

新推送的组将继承堆栈顶层组的相同过滤设置；也就是说，过滤设置不会因推送新组而改变。

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

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

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

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

QOpenGLDebugLogger 当日志记录开始时，将记录 和 的值，并在日志记录停止时将其设回。此外，在调用此函数时安装的任何用户定义的 OpenGL 调试回调都将在停止日志记录时恢复； 将确保在日志记录时仍然调用预先存在的回调。GL_DEBUG_OUTPUT GL_DEBUG_OUTPUT_SYNCHRONOUS QOpenGLDebugLogger

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

[slot] void QOpenGLDebugLogger::stopLogging()

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

另请参阅 startLogging().