QQuickRenderControl Class

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

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

親オブジェクトがparent であるQQuickRenderControlオブジェクトを作成します。

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

インスタンスを破棄します。すべてのシーングラフリソースを解放します。

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 のレンダリングコマンドはここでデバイスコンテキストに送信されます

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

関連項目： endFrame()、initialize()、sync()、render()、QQuickGraphicsDevice 、およびQQuickRenderTarget 。

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

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

beginFrame() が呼び出されると、QRhiCommandBuffer が自動的に設定されます。これは、Qt Quick シーングラフが使用するコマンドバッファですが、場合によっては、アプリケーション側でも（例えば、リソースの更新（テクスチャの読み込みなど）を実行するために）これを照会したい場合があります。

返されるコマンドバッファの参照は、beginFrame() とendFrame() の間でのみ使用すべきです。ただし、特定の例外があります。例えば、endFrame() の直後、かつ次のbeginFrame() よりも前に、そのコマンドバッファに対してlastCompletedGpuTime() を呼び出すことは有効です。

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

関連項目： rhi()、beginFrame()、およびendFrame()。

[since 6.0] void QQuickRenderControl::endFrame()

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

この関数が呼び出されると、シーングラフによってキューに入れられたグラフィックスコマンドは、該当する方（コンテキストまたはコマンドキュー）に送信されます。

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

関連項目： beginFrame()、initialize()、sync()、render()、QQuickGraphicsDevice 、およびQQuickRenderTarget 。

[since 6.0] bool QQuickRenderControl::initialize()

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

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

シーングラフが独自のデバイスおよびコンテキストオブジェクトを作成しないようにするには、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 で導入されました。