QOpenGLContext Class

メンバ関数のドキュメント

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

親オブジェクトparent を持つ新しい OpenGL コンテキストインスタンスを作成します。

使用するには、適切なフォーマットを設定し、create() を呼び出す必要があります。

create() およびmakeCurrent()も参照してください 。

[virtual noexcept] QOpenGLContext::~QOpenGLContext()

QOpenGLContext オブジェクトを破棄します。

これがスレッドの現在のコンテキストである場合、doneCurrent() も呼び出されます。

[signal] void QOpenGLContext::aboutToBeDestroyed()

このシグナルは、基となるネイティブの OpenGL コンテキストが破棄される前に発せられます。これにより、ユーザーは、共有 OpenGL コンテキストの場合に未処理のまま残ってしまう可能性のある OpenGL リソースをクリーンアップすることができます。

クリーンアップを行うためにコンテキストをアクティブにしたい場合は、必ずダイレクト接続を使用してこのシグナルに接続するようにしてください。

[static] bool QOpenGLContext::areSharing(QOpenGLContext *first, QOpenGLContext *second)

first およびsecond のコンテキストが OpenGL リソースを共有している場合、true を返します。

bool QOpenGLContext::create()

現在の設定で OpenGL コンテキストを作成しようとします。

現在の設定には、フォーマット、シェアコンテキスト、およびスクリーンが含まれます。

お使いのシステムの OpenGL 実装が、要求されたバージョンの OpenGL コンテキストをサポートしていない場合、QOpenGLContext は、それに最も近いバージョンのコンテキストを作成しようと試みます。 実際に作成されたコンテキストのプロパティは、format() 関数が返すQSurfaceFormat を使用して照会できます。たとえば、OpenGL 4.3 コアプロファイルをサポートするコンテキストを要求したものの、ドライバやハードウェアがバージョン 3.2 コアプロファイルのコンテキストしかサポートしていない場合、3.2 コアプロファイルのコンテキストが取得されます。

ネイティブコンテキストが正常に作成され、makeCurrent() やswapBuffers() などで使用可能な状態になっている場合、true を返します。

makeCurrent() およびformat()も参照してください 。

[static] QOpenGLContext *QOpenGLContext::currentContext()

現在のスレッド内でmakeCurrent を呼び出した最後のコンテキストを返します。現在のコンテキストがない場合は、nullptr を返します。

GLuint QOpenGLContext::defaultFramebufferObject() const

現在のサーフェスのデフォルトのフレームバッファオブジェクトを取得するには、これを呼び出します。

一部のプラットフォーム（例えばiOS）では、デフォルトのフレームバッファオブジェクトはレンダリング先のサーフェスによって異なり、0とは異なる値になる場合があります。 したがって、アプリケーションをさまざまな Qt プラットフォームで動作させたい場合は、glBindFramebuffer(0) を呼び出す代わりに、glBindFramebuffer(ctx->defaultFramebufferObject()) を呼び出す必要があります。

QOpenGLFunctions 内の glBindFramebuffer() を使用する場合は、0 が渡されると現在のコンテキストの defaultFramebufferObject() が自動的にバインドされるため、この点について心配する必要はありません。

QOpenGLFramebufferObjectも参照してください 。

void QOpenGLContext::doneCurrent()

0のサーフェスを指定してmakeCurrent を呼び出すための便利な関数です。

これにより、現在のスレッドではコンテキストが存在しなくなります。

makeCurrent() およびcurrentContext()も参照してください 。

QSet<QByteArray> QOpenGLContext::extensions() const

このコンテキストでサポートされている OpenGL 拡張機能のセットを返します。

コンテキストまたは共有コンテキストがアクティブである必要があります。

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

QOpenGLExtraFunctions *QOpenGLContext::extraFunctions() const

このコンテキストのQOpenGLExtraFunctions インスタンスを取得します。

QOpenGLContext これは、QOpenGLExtraFunctions を手動で管理することなくアクセスするための便利な方法として提供されています。

コンテキストまたは共有コンテキストがアクティブである必要があります。

返されたQOpenGLExtraFunctions インスタンスはすぐに使用可能であり、initializeOpenGLFunctions() を呼び出す必要はありません。

「 QOpenGLFunctions 」および「QOpenGLExtraFunctions 」も参照してください 。

QSurfaceFormat QOpenGLContext::format() const

create() が呼び出されている場合、基になるプラットフォームコンテキストのフォーマットを返します。

それ以外の場合は、要求されたフォーマットを返します。

要求されたフォーマットと実際のフォーマットは異なる場合があります。特定の OpenGL バージョンを要求しても、結果として得られるコンテキストが要求されたバージョンと完全に一致するとは限りません。ドライバがそのようなコンテキストを提供できる限り、作成されるコンテキストのバージョン／プロファイル／オプションの組み合わせが要求と互換性があることのみが保証されます。

たとえば、OpenGL バージョン 3.x コアプロファイルのコンテキストを要求しても、OpenGL 4.x コアプロファイルのコンテキストが返される場合があります。同様に、OpenGL 2.1 を要求しても、非推奨の関数が有効になった OpenGL 3.0 のコンテキストが返される場合があります。 最後に、ドライバによっては、サポートされていないバージョンを要求した場合、コンテキストの作成に失敗するか、サポートされている最高バージョンのコンテキストが生成される場合があります。

バッファサイズにおいても同様の違いが生じる可能性があります。たとえば、結果として得られるコンテキストの深度バッファが、要求したサイズよりも大きくなる場合があります。これはまったく正常な動作です。

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

QOpenGLFunctions *QOpenGLContext::functions() const

このコンテキストのQOpenGLFunctions インスタンスを取得します。

QOpenGLContext これは、QOpenGLFunctions を手動で管理することなくアクセスできる便利な方法として提供されています。

コンテキストまたは共有コンテキストがアクティブである必要があります。

返されたQOpenGLFunctions インスタンスはすぐに使用可能であり、initializeOpenGLFunctions() を呼び出す必要はありません。

QFunctionPointer QOpenGLContext::getProcAddress(const QByteArray &procName) const

procName で指定されたOpenGL拡張関数への関数ポインタを解決します。

この関数を使用すると、すべてのプラットフォームでリンク済みシンボルとして利用できない可能性がある OpenGL 拡張関数やコア関数にアクセスできます。

返されるポインタはプラットフォームに依存する場合があります。一部のシステムでは、関数が無効またはサポートされていない場合でも、nullptr ではないポインタが返されることがあります。

関数の利用可否を確実に確認するには、QOpenGLContext::hasExtension() を呼び出して拡張機能のサポートを確認してください。コア関数については、QOpenGLContext::format() によって返されるQSurfaceFormat 内のversion() を使用して、現在のコンテキストのバージョンを確認してください。

QFunctionPointer QOpenGLContext::getProcAddress(const char *procName) const

[static] QOpenGLContext *QOpenGLContext::globalShareContext()

存在する場合、アプリケーション全体で共有される OpenGL コンテキストを返します。存在しない場合は、nullptr を返します。

これは、QOpenGLWidget やQQuickWidget を作成または表示する前に、OpenGL オブジェクト（バッファ、テクスチャなど）をアップロードする必要がある場合に便利です。

関連項目： Qt::AA_ShareOpenGLContexts 、setShareContext()、およびmakeCurrent()。

bool QOpenGLContext::hasExtension(const QByteArray &extension) const

この OpenGL コンテキストが指定された OpenGLextension をサポートしている場合は `true ` を返し、そうでない場合は `false ` を返します。

コンテキストまたは共有コンテキストがアクティブである必要があります。

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

bool QOpenGLContext::isOpenGLES() const

コンテキストが OpenGL ES コンテキストである場合、true を返します。

コンテキストがまだ作成されていない場合、結果はsetFormat() を通じて指定されたフォーマットに基づいて決定されます。

create()、format()、およびsetFormat()も参照してください 。

bool QOpenGLContext::isValid() const

このコンテキストが有効である場合、つまり正常に作成された場合に真を返します。

一部のプラットフォームでは、以前に正常に作成されたコンテキストに対してfalse を呼び出した際の戻り値が、OpenGLコンテキストが失われたことを示す場合があります。

アプリケーションでコンテキストの喪失に対処する一般的な方法は、makeCurrent() が失敗してfalse を返した際に、この関数を使用して確認することです。この関数がfalse を返した場合は、create() を呼び出して基盤となるネイティブ OpenGL コンテキストを再作成し、makeCurrent() を再度呼び出して、すべての OpenGL リソースを再初期化します。

一部のプラットフォームでは、コンテキストの喪失は避けられない状況です。しかし、他のプラットフォームでは、これを明示的に有効にする必要がある場合があります。これは、QSurfaceFormat 内でResetNotification を有効にすることで実現できます。これにより、基盤となるネイティブOpenGLコンテキストにおいてRESET_NOTIFICATION_STRATEGY_EXT がLOSE_CONTEXT_ON_RESET_EXT に設定されます。その後、QOpenGLContext は、各makeCurrent()内でglGetGraphicsResetStatusEXT() を介してステータスを監視します。

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

bool QOpenGLContext::makeCurrent(QSurface *surface)

指定されたsurface に対して、現在のスレッドでコンテキストをアクティブにします。成功した場合はtrue を返し、そうでない場合はfalse を返します。後者のエラーは、サーフェスが公開されていない場合や、例えばアプリケーションがサスペンドされているなどの理由でグラフィックスハードウェアが利用できない場合に発生する可能性があります。

surface がnullptr の場合、これはdoneCurrent()を呼び出すことと同等です。

QOpenGLContext インスタンスが存在するスレッドとは異なるスレッドから、この関数を呼び出すことは避けてください。別のスレッドからQOpenGLContext を使用したい場合は、まず、必要に応じてdoneCurrent() を呼び出して、それが現在のスレッドでアクティブではないことを確認する必要があります。その後、別のスレッドで使用する前に moveToThread(otherThread) を呼び出してください。

デフォルトでは、Qt はスレッドアフィニティに関して上記の条件を強制するチェックを行っています。ただし、Qt::AA_DontCheckOpenGLContextThreadAffinity アプリケーション属性を設定することで、このチェックを無効にすることも可能です。QObject thread affinity のドキュメントで説明されているように、QObject をそれが存在するスレッドの外から使用する際の影響を必ず理解しておいてください。

functions()、doneCurrent()、およびQt::AA_DontCheckOpenGLContextThreadAffinityも参照してください 。

template <typename QNativeInterface> QNativeInterface *QOpenGLContext::nativeInterface() const

コンテキストに対して、指定された型のネイティブインターフェースを返します。

この関数は、QNativeInterface 名前空間で定義されているQOpenGLContext のプラットフォーム固有の機能へのアクセスを提供します：

要求されたインターフェースが利用できない場合、nullptr が返されます。

[static] QOpenGLContext::OpenGLModuleType QOpenGLContext::openGLModuleType()

基礎となる OpenGL 実装の型を返します。

OpenGLの実装が動的にロードされないプラットフォームでは、戻り値はコンパイル時に決定され、変更されることはありません。

QScreen *QOpenGLContext::screen() const

そのコンテキストが作成された画面を返します。

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

void QOpenGLContext::setFormat(const QSurfaceFormat &format)

OpenGLコンテキストが互換性を持つべきformat を設定します。この設定を有効にするには、事前にcreate()を呼び出す必要があります。

この関数によってフォーマットが明示的に設定されていない場合、QSurfaceFormat::defaultFormat() が返すフォーマットが使用されます。つまり、複数のコンテキストがある場合、この関数への個別の呼び出しは、最初のコンテキストを作成する前にQSurfaceFormat::setDefaultFormat() を 1 回呼び出すことで置き換えることができます。

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

void QOpenGLContext::setScreen(QScreen *screen)

OpenGLコンテキストが有効となるscreen を設定します。設定を有効にするには、create() を呼び出す必要があります。

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

void QOpenGLContext::setShareContext(QOpenGLContext *shareContext)

これにより、このコンテキストはshareContext とテクスチャ、シェーダー、およびその他のOpenGLリソースを共有するようになります。この設定が有効になるには、create()を呼び出す必要があります。

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

QOpenGLContext *QOpenGLContext::shareContext() const

このコンテキストが作成された際に使用された共有コンテキストを返します。

要求された共有を基盤となるプラットフォームがサポートできなかった場合、0が返されます。

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

QOpenGLContextGroup *QOpenGLContext::shareGroup() const

このコンテキストが属するシェアグループを返します。

[static] bool QOpenGLContext::supportsThreadedOpenGL()

プラットフォームがメイン（GUI）スレッド外での OpenGL レンダリングをサポートしている場合、true を返します。

この値は、使用中のプラットフォームプラグインによって制御され、グラフィックスドライバによっても異なる場合があります。

QSurface *QOpenGLContext::surface() const

コンテキストとして現在設定されているサーフェスを返します。

これは、makeCurrent() の引数として渡されたサーフェスです。

void QOpenGLContext::swapBuffers(QSurface *surface)

surface のバックバッファとフロントバッファを入れ替えます。

OpenGLのレンダリングフレームを終了するにはこれを呼び出し、新しいフレームの一部としてなど、それ以降のOpenGLコマンドを実行する前に、必ず再度makeCurrent()を呼び出すようにしてください。