QQuickRenderControl Class

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

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

親オブジェクトparent を持つ QQuickRenderControl オブジェクトを構築します。

[override virtual noexcept] QQuickRenderControl::~QQuickRenderControl()

インスタンスを破棄します。すべての scenegraph リソースを解放します。

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

[since 6.0] void QQuickRenderControl::beginFrame()

グラフィックス・フレームの開始を指定します。sync() またはrender() の呼び出しは、beginFrame() およびendFrame() の呼び出しで囲む必要があります。

Qt 5以前のOpenGLのみの世界とは異なり、他のグラフィックスAPIを使用したレンダリングでは、フレームの開始と終了のポイントがより明確に定義されている必要があります。QQuickRenderControl を介して手動でレンダリングループを駆動する場合、これらのポイントを指定するのはQQuickRenderControl のユーザーになりました。

既存のテクスチャへのレンダリングの初期化を含む、典型的な更新ステップは次のようになります。スニペット例ではDirect3D 11を想定していますが、他のグラフィックスAPIでも同じコンセプトが適用されます。

if (!m_quickInitialized) {
    m_quickWindow->setGraphicsDevice(QQuickGraphicsDevice::fromDeviceAndContext(m_engine->device(), m_engine->context()));

    if (!m_renderControl->initialize())
        qWarning("Failed to initialize redirected Qt Quick rendering");

    m_quickWindow->setRenderTarget(QQuickRenderTarget::fromNativeTexture({ quint64(m_res.texture), 0 },
                                                                         QSize(QML_WIDTH, QML_HEIGHT),
                                                                         SAMPLE_COUNT));

    m_quickInitialized = true;
}

m_renderControl->polishItems();

m_renderControl->beginFrame();
m_renderControl->sync();
m_renderControl->render();
m_renderControl->endFrame(); // Qt Quick's rendering commands are submitted to the device context here

この関数は Qt 6.0 で導入されました。

endFrame(),initialize(),sync(),render(),QQuickGraphicsDevice, およびQQuickRenderTargetも参照してください 。

[since 6.6] QRhiCommandBuffer *QQuickRenderControl::commandBuffer() const

現在のコマンド・バッファを返します。

beginFrame() が呼び出されると、自動的にQRhiCommandBuffer がセットアップされます。これは、Qt Quick scenegraph が使用するコマンド・バッファですが、アプリケーションによっては、リソースの更新（例えば、テクスチャのリードバックなど）を発行するために、このコマンド・バッファに問い合わせたい場合もあります。

返されたコマンド・バッファ・リファレンスは、beginFrame() とendFrame() の間でのみ使用されるべきです。例えば、endFrame （）の直後で、次のbeginFrame （）の前にコマンドバッファ上でlastCompletedGpuTime （）を呼び出すことは有効です。

この関数は Qt 6.6 で導入されました。

rhi(),beginFrame(),endFrame()も参照してください 。

[since 6.0] void QQuickRenderControl::endFrame()

グラフィックス・フレームの終了を指定します。sync() またはrender() の呼び出しは、beginFrame() および endFrame() の呼び出しで囲む必要があります。

この関数が呼び出されると、scenegraph によってキューに入れられたグラフィックス・コマンドは、コンテキストまたはコマンド・キューのいずれか適用可能な方に提出されます。

この関数はQt 6.0で導入されました。

beginFrame()、initialize()、sync()、render()、QQuickGraphicsDevice 、QQuickRenderTargetも参照してください 。

[since 6.0] bool QQuickRenderControl::initialize()

シーン・グラフ・リソースを初期化します。Qt Quick のレンダリングに Vulkan、Metal、OpenGL、Direct3D などのグラフィックス API を使用する場合、この関数が呼び出されるとQQuickRenderControl が適切なレンダリングエンジンをセットアップします。このレンダリングインフラストラクチャは、QQuickRenderControl が存在する限り存在します。

Qt Quick が使用するグラフィック API を制御するには、QSGRendererInterface:GraphicsApi 定数のいずれかを指定してQQuickWindow::setGraphicsApi() を呼び出します。これは、この関数を呼び出す前に行う必要があります。

シーングラフが独自のデバイス・オブジェクトとコンテキスト・オブジェクトを作成しないようにするには、QQuickWindow::setGraphicsDevice() を呼び出して、既存のグラフィックス・オブジェクトをラップする適切なQQuickGraphicsDevice を指定します。

どのデバイス拡張を有効にするかを設定するには（たとえば、Vulkan の場合）、この関数の前にQQuickWindow::setGraphicsConfiguration() を呼び出します。

成功すればtrue を、そうでなければfalse を返します。

デフォルトのQt Quick適応では、この関数は新しいQRhi オブジェクトを作成します。これは、QQuickRenderControl が使用されていないときに、画面上のQQuickWindow で起こることと同じです。この新しいQRhi オブジェクトに既存のデバイスやコンテキストリソースを採用させるには（例えば、新しいQOpenGLContext を作成する代わりに既存の を使用する）、前述のようにQQuickWindow::setGraphicsDevice() を使用します。Qt Quick のレンダリングに既存のQRhi オブジェクトを使用させたい場合は、QQuickGraphicsDevice::fromRhi() を使用します。既に存在するQRhi を参照するQQuickGraphicsDevice が設定されている場合、initialize() で作成される新しい専用のQRhi オブジェクトはありません。

この関数は Qt 6.0 で導入されました。

QQuickRenderTarget,QQuickGraphicsDevice,QQuickGraphicsConfiguration::preferredInstanceExtensions()も参照してください 。

void QQuickRenderControl::invalidate()

レンダリングを停止し、リソースを解放します。

これは、実際のQQuickWindow でウィンドウが非表示になったときに行われるクリーンアップ操作に相当します。

この関数はデストラクタから呼び出されます。したがって、通常、この関数を直接呼び出す必要はありません。

invalidate()が呼び出されると、initialize()を再度呼び出すことで、QQuickRenderControl インスタンスを再利用することができる。

void QQuickRenderControl::polishItems()

この関数は、sync() のできるだけ前に呼び出す必要があります。スレッド化されたシナリオでは、この関数と並行してレンダリングを行うことができます。

void QQuickRenderControl::prepareThread(QThread *targetThread)

GUIスレッドの外でQt Quickシーンのレンダリングを準備します。

targetThread は、同期とレンダリングが行われるスレッドを指定します。シングルスレッドでこの関数を呼び出す必要はありません。

void QQuickRenderControl::render()

現在のコンテキストを使用してシーングラフをレンダリングします。

[signal] void QQuickRenderControl::renderRequested()

このシグナルは、シーングラフをレンダリングする必要があるときに発せられます。sync()を呼び出す必要はありません。

[virtual] QWindow *QQuickRenderControl::renderWindow(QPoint *offset)

このレンダーコントロールがレンダリングしている実際のウィンドウを返すために、サブクラスで再実装されます。

offset がnullでない場合、ウィンドウ内のコントロールのオフセットが設定されます。

[static] QWindow *QQuickRenderControl::renderWindowFor(QQuickWindow *win, QPoint *offset = nullptr)

もしあれば、win がレンダリングされている実際のウィンドウを返します。

offset が NULL でない場合、そのウィンドウ内でのレンダリングのオフセットが設定されます。

[since 6.6] QRhi *QQuickRenderControl::rhi() const

このQQuickRenderControl が関連付けられているQRhi を返します。

この関数は Qt 6.6 で導入されました。

commandBuffer(),beginFrame(),endFrame()も参照してください 。

[since 6.0] int QQuickRenderControl::samples() const

現在のサンプル数を返します。1または0は、マルチサンプリングがないことを意味します。

この関数は Qt 6.0 で導入されました。

setSamples()も参照 。

[signal] void QQuickRenderControl::sceneChanged()

このシグナルは、シーン・グラフが更新されたときに発せられる。つまり、polishItems （）とsync （）を呼び出す必要がある。sync() が true を返した場合、render() を呼び出す必要があります。

[since 6.0] void QQuickRenderControl::setSamples(int sampleCount)

マルチサンプリングに使用するサンプル数を設定します。sampleCount が 0 または 1 の場合、マルチサンプリングは無効になります。

この関数は Qt 6.0 で導入されました。

samples(),initialize(),QQuickRenderTargetも参照してください 。

bool QQuickRenderControl::sync()

この関数は、QMLシーンとレンダリングシーングラフの同期に使用されます。

専用のレンダリングスレッドが使用されている場合、GUIスレッドはこの呼び出しの間ブロックされなければなりません。

同期によってシーングラフが変更された場合、true を返します。

[since 6.0] QQuickWindow *QQuickRenderControl::window() const

このQQuickRenderControl が関連付けられているQQuickWindow を返す。

この関数は Qt 6.0 で導入されました。