QOpenGLExtraFunctions::glObjectPtrLabel()によるOpenGLオブジェクトのラベル付け

Qt GUIにおけるQOpenGLExtraFunctions::glObjectPtrLabel()解説

QOpenGLExtraFunctions::glObjectPtrLabel()は、Qt GUIアプリケーションでOpenGLオブジェクトにラベルを割り当てるための関数です。ラベルは、デバッギングやパフォーマンス分析を容易にするために役立ちます。

機能

• OpenGLオブジェクトの種類（テクスチャ、シェーダー、バッファなど）を指定できます。
• オブジェクトIDを指定できます。
• ラベル文字列を指定できます。

利点

• デバッグ時にオブジェクトを識別しやすくなります。
• パフォーマンス分析ツールでオブジェクトを追跡しやすくなります。

コード例

#include <QtOpenGL>

void Example() {
  // OpenGLオブジェクトを作成
  GLuint texture = glGenTextures(1);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_TEXTURE, texture, "My Texture");

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);
}

補足

• Qt 5.14以降で利用可能です。
• OpenGL 4.3以降が必要です。

• デバッギングツールによっては、ラベルが自動的に表示されない場合があります。その場合は、ツール設定でラベル表示を有効にする必要があります。
• ラベル文字列は、UTF-8エンコードで指定する必要があります。

Qt GUIにおけるQOpenGLExtraFunctions::glObjectPtrLabel() のサンプルコード

#include <QtOpenGL>

void Example() {
  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_TEXTURE, texture, "My Texture");

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);
}

シェーダーにラベルを割り当てる

#include <QtOpenGL>

void Example() {
  // OpenGLシェーダーを作成
  GLuint shader = glCreateShader(GL_VERTEX_SHADER);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_SHADER, shader, "My Shader");

  // シェーダーソースコードを設定
  // ...

  // シェーダーをコンパイル
  // ...

  // シェーダーを使用するコード

  // シェーダーを削除
  glDeleteShader(shader);
}

バッファにラベルを割り当てる

#include <QtOpenGL>

void Example() {
  // OpenGLバッファを作成
  GLuint buffer = glGenBuffers(1);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_BUFFER, buffer, "My Buffer");

  // バッファデータを設定
  // ...

  // バッファを使用するコード

  // バッファを削除
  glDeleteBuffers(1, &buffer);
}

複数のオブジェクトにラベルを割り当てる

#include <QtOpenGL>

void Example() {
  // OpenGLテクスチャを作成
  GLuint texture1 = glGenTextures(1);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_TEXTURE, texture1, "Texture 1");

  // OpenGLテクスチャを作成
  GLuint texture2 = glGenTextures(1);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_TEXTURE, texture2, "Texture 2");

  // ...

  // テクスチャを削除
  glDeleteTextures(1, &texture1);
  glDeleteTextures(1, &texture2);
}

ラベル文字列を動的に設定する

#include <QtOpenGL>
#include <QString>

void Example() {
  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベル文字列を動的に生成
  QString label = "Texture " + QString::number(texture);

  // ラベルを割り当てる
  QOpenGLExtraFunctions::glObjectPtrLabel(GL_TEXTURE, texture, label.toUtf8().data());

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);
}

ラベルの長さを制限する

#include <QtOpenGL>

void Example() {
  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベル文字列を制限
  const char* label = "My Texture";
  const int maxLength = 32;

  // ラベルを

Qt GUIにおけるOpenGLオブジェクトのラベル付けのその他の方法

Qt 5.15以降では、QOpenGLDebugLoggerを使用してOpenGLオブジェクトにラベルを割り当てることができます。

#include <QtOpenGL>

void Example() {
  // OpenGLデバッガーを作成
  QOpenGLDebugLogger logger;

  // デバッガーを有効にする
  logger.startLogging();

  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベルを割り当てる
  logger.logMessage(QOpenGLDebugMessage::カテゴリー::その他,
                    QOpenGLDebugMessage::重大度::情報,
                    "My Texture",
                    (void*)texture);

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);

  // デバッガーを無効にする
  logger.stopLogging();
}

GL_OBJECT_LABEL_KHR拡張機能を使用する

Qt 5.14以前を使用している場合、またはOpenGL 4.3未満を使用している場合は、GL_OBJECT_LABEL_KHR拡張機能を使用してOpenGLオブジェクトにラベルを割り当てることができます。

#include <QtOpenGL>

void Example() {
  // OpenGL拡張機能を有効にする
  QOpenGLFunctions::glInitFunctions();

  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベルを割り当てる
  glObjectLabelKHR(GL_TEXTURE, texture, "My Texture");

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);
}

自作のラベル管理システムを使用する

上記のいずれの方法も使用できない場合は、独自のラベル管理システムを作成することができます。

#include <QtOpenGL>

struct ObjectLabel {
  GLuint objectId;
  QString label;
};

// ラベルのリスト
QVector<ObjectLabel> labels;

void Example() {
  // OpenGLテクスチャを作成
  GLuint texture = glGenTextures(1);

  // ラベルをリストに追加
  labels.append({texture, "My Texture"});

  // テクスチャを使用するコード

  // テクスチャを削除
  glDeleteTextures(1, &texture);

  // ラベルをリストから削除
  labels.removeOne({texture, ""});
}

Qt GUIアプリケーションでOpenGLオブジェクトにラベルを割り当てるには、いくつかの方法があります。

• QOpenGLExtraFunctions::glObjectPtrLabel()を使用する (Qt 5.14以降、OpenGL 4.3以降)
• QOpenGLDebugLoggerを使用する (Qt 5.15以降)
• GL_OBJECT_LABEL_KHR拡張機能を使用する (Qt 5.14以前、OpenGL 4.3未満)
• 自作のラベル管理システムを使用する