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)

OpenGL デバッグログに「debugMessage 」というメッセージを挿入します。これにより、アプリケーションやライブラリは、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 」、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()も参照してください 。