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

const QList<QOpenGLDebugMessage> messages = logger->loggedMessages();
for (const QOpenGLDebugMessage &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は自動的に、ポップされたグループのメッセージ、id、ソースに一致するメッセージ、タイプQOpenGLDebugMessage::GroupPopType 、重大度QOpenGLDebugMessage::NotificationSeverity をログに記録します。

デバッググループをポップすると、デバッググループスタックのトップになるグループのメッセージフィルタリング設定が復元されます。

pushGroup()も参照してください 。

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

名前name 、idid 、ソースsource を持つデバッグ・グループをデバッグ・グループ・スタックにプッシュします。グループが正常にプッシュされると、OpenGLは自動的にメッセージname 、idid 、ソースsource 、タイプQOpenGLDebugMessage::GroupPushType 、重大度QOpenGLDebugMessage::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()も参照して ください。