QSGRenderNode Class

QSGRenderNodeクラスは、scenegraphで使用されているグラフィックスAPIをターゲットとしたカスタムレンダリングコマンドのセットを表します。詳細...

Header: #include <QSGRenderNode>
CMake: find_package(Qt6 REQUIRED COMPONENTS Quick)
target_link_libraries(mytarget PRIVATE Qt6::Quick)
qmake: QT += quick
Inherits: QSGNode

パブリックタイプ

enum RenderingFlag { BoundedRectRendering, DepthAwareRendering, OpaqueRendering, NoExternalRendering }
flags RenderingFlags
enum StateFlag { DepthState, StencilState, ScissorState, ColorState, BlendState, …, RenderTargetState }
flags StateFlags

パブリック関数

virtual ~QSGRenderNode() override
virtual QSGRenderNode::StateFlags changedStates() const
const QSGClipNode *clipList() const
(since 6.6) QRhiCommandBuffer *commandBuffer() const
virtual QSGRenderNode::RenderingFlags flags() const
qreal inheritedOpacity() const
const QMatrix4x4 *matrix() const
(since 6.0) virtual void prepare()
(since 6.5) const QMatrix4x4 *projectionMatrix() const
virtual QRectF rect() const
virtual void releaseResources()
virtual void render(const QSGRenderNode::RenderState *state) = 0
(since 6.6) QRhiRenderTarget *renderTarget() const

詳細説明

QSGRenderNode は、QRhi (Qt 6.6 以降の一般的なアプローチ)、OpenGL、Vulkan、Metal などの 3D グラフィックス API を直接、またはsoftware バックエンドが使用されている場合はQPainter を介して、独自のカスタムレンダリングを実行するシーングラフノードを作成することができます。

QSGRenderNode は、Qt Quick シーンにカスタム 2D/3D レンダリングを統合する 3 つの方法の 1 つです。他の2つのオプションは、before またはafter Qt Quick シーン自身のレンダリングを実行すること、または専用のレンダーターゲット(テクスチャ)をターゲットとする全く別のレンダーパスを生成し、シーン内のアイテムにテクスチャを表示させることです。QSGRenderNodeベースのアプローチは、追加のレンダーパスやレンダーターゲットが関与しないという意味で、前者に似ており、Qt Quickシーン自身のレンダリングと "インライン "でカスタムレンダリングコマンドを注入することができます。

シーングラフ - カスタム QSGRenderNodeも参照してください

メンバ型ドキュメント

enum QSGRenderNode::RenderingFlag
flags QSGRenderNode::RenderingFlags

flags() から返されるビットマスクの可能な値。

定数説明
QSGRenderNode::BoundedRectRendering0x01render() の実装が、アイテム座標でrect() から報告された領域の外側をレンダリングしないことを示します。このようなノードの実装は、scenegraph バックエンドによっては、より効率的なレンダリングにつながります。たとえば、software バックエンドは、シーン内のすべてのレンダーノードにこのフラグが設定されている場合、より最適な部分更新パスを使用し続けることができます。
QSGRenderNode::DepthAwareRendering0x02render ()の実装が、render ()のノートに記載されているように、RenderState::projectionMatrix()とmatrix ()から取得された行列によって変換されるシーン座標で0のZ値のみを生成することによって、シーングラフの期待に準拠していることを示します。このようなノードの実装は、シーングラフバックエンドによっては、より効率的なレンダリングにつながります。たとえば、シーン内のすべてのレンダーノードにこのフラグが設定されている場合、バッチOpenGLレンダラーは、より最適なパスを使用し続けることができます。
QSGRenderNode::OpaqueRendering0x04render ()の実装が、rect ()から報告された領域全体の不透明ピクセルを書き出すことを示します。デフォルトでは、レンダラーは、render ()が半透明または完全な透明ピクセルも出力できることを想定する必要があります。このフラグを設定すると、パフォーマンスが向上する場合がある。
QSGRenderNode::NoExternalRendering0x08prepare() およびrender() の実装が、OpenGL、Vulkan、または Metal などの 3D API を直接呼び出すのではなく、QRhi ファミリーの API を使用することを示します。

RenderingFlags型はQFlags<RenderingFlag>のtypedefである。レンダリングフラグの値の OR の組み合わせを格納します。

render(),prepare(),rect(),QRhiも参照してください

enum QSGRenderNode::StateFlag
flags QSGRenderNode::StateFlags.

この列挙は、いくつかの状態を識別するビットマスクです。

定数説明
QSGRenderNode::DepthState0x01深さ
QSGRenderNode::StencilState0x02ステンシル
QSGRenderNode::ScissorState0x04シザー
QSGRenderNode::ColorState0x08カラー
QSGRenderNode::BlendState0x10ブレンド
QSGRenderNode::CullState0x20カル
QSGRenderNode::ViewportState0x40ポートを見る
QSGRenderNode::RenderTargetState0x80レンダーターゲット

StateFlags型はQFlags<StateFlag>のtypedefである。StateFlagの値のORの組み合わせを格納する。

メンバ関数の説明

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

レンダーノードをデストラクトします。派生クラスは、ここでreleaseResources() と同様のクリーンアップを実行することが期待される。

低レベルのグラフィックスAPIが使用されているとき、シーングラフは、シーングラフのノードが削除される前に、GPUがシーングラフのグラフィックスコマンドキューに提出されたすべての作業を完了するために、CPU側の待ち時間があることを確認します。したがって、render ()の実装が追加のコマンド・キューを使用していない限り、ここで追加の待ちを発行する必要はありません。

QRhiQRhiBufferQRhiTextureQRhiGraphicsPipeline などのリソースでは、std::unique_ptr などのスマート・ポインタを使用すると、デストラクタを実装する必要がなくなり、ソース・コードがよりコンパクトになります。しかし、releaseResources() を実装し、unique_ptrに対して多くのreset()コールを発行することが重要であることに留意してください。

releaseResources()も参照のこと

[virtual] QSGRenderNode::StateFlags QSGRenderNode::changedStates() const

基礎となるレンダリングAPIがOpenGLである場合、この関数は、各ビットがrender() 関数によって変更されたグラフィックス状態を表すマスクを返す必要があります:

定数説明
DepthState深度書き込みマスク、深度テスト有効、深度比較関数
StencilStateステンシル書き込みマスク、ステンシルテスト有効、ステンシル操作、ステンシル比較関数
ScissorStateシザー有効、シザーテスト有効
ColorStateクリアカラー、カラー書き込みマスク
BlendStateブレンド、ブレンド機能
CullStateフロントフェイス、カルフフェイス
ViewportStateビューポート
RenderTargetStateレンダーターゲット

OpenGL以外のAPIでは、コマンドリスト/バッファに記録された動的な状態変化に対応する値のみが関連する。例えば、D3D11 の場合、RSSetViewports、RSSetScissorRects、OMSetBlendState、OMSetDepthStencilState、Vulkan の場合、vkCmdSetViewport、vkCmdSetScissor、vkCmdSetBlendConstants、vkCmdSetStencilRef などで、このようなコマンドが QSGRendererInterface を介して照会されたシーングラフのコマンドリストに追加された場合のみです:CommandList リソース列挙型(CommandList resource enum)を介して照会されたシーングラフのコマンドリストに追加された場合のみです。パイプライン状態オブジェクトに設定された状態は、ここで報告する必要はありません。同様に、描画呼び出しに関連する設定(パイプラインステート、記述子セット、頂点またはインデックスバッファバインディング、ルート署名、記述子ヒープなど)は、常にシーングラフによって再度設定されるため、render ()は自由に変更できます。

RenderTargetState は、Vulkan のような API ではサポートされなくなりました。これは性質によるものです。()は、Qt Quick scenegraphのメインコマンドバッファがレンダーパスを記録している間に呼び出されるため、ターゲットを変更して別のレンダーパスを開始する可能性はありません(少なくともそのコマンドバッファ上では)。そのため、 が設定された値を返すことは賢明ではありません。render RenderTargetState

注: software バックエンドは、QPainter を公開し、render() を呼び出す前後に保存と復元を行う。したがって、ここから変更された状態を報告する必要はない。

この関数はレンダラーによって呼び出されるため、レンダラーはこのノードをレンダリングした後に状態をリセットできます。これにより、render ()の実装は、これらの状態を照会してリストアする必要がなくなるため、シンプルになる。

デフォルトの実装では、render() で関連する状態が変更されなかったことを意味する 0 を返します。

注意: この関数は、render() の前に呼び出すことができます。

注意: Qt 6 とQRhi ベースのレンダリングでは、関連する値はViewportStateScissorState だけです。他の値を返すこともできますが、実際には無視されます。

const QSGClipNode *QSGRenderNode::clipList() const

現在のクリップリストを返します。

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

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

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

renderTarget()も参照してください

[virtual] QSGRenderNode::RenderingFlags QSGRenderNode::flags() const

レンダーノードの動作を表すフラグを返します。

デフォルトの実装は 0 を返します。

RenderingFlag およびrect() も参照して ください。

qreal QSGRenderNode::inheritedOpacity() const

現在の実効不透明度を返します。

const QMatrix4x4 *QSGRenderNode::matrix() const

現在のモデルビュー行列へのポインタを返します。

[virtual, since 6.0] void QSGRenderNode::prepare()

フレーム準備フェーズから呼び出されます。render() を呼び出すたびに、その前にこの関数が呼び出されます。

render() とは異なり、この関数は、scenegraph が現在のフレームのレンダーパスを基礎となるコマンドバッファに記録し始める前に呼び出されます。これは、コピータイプの操作がレンダーパスの前に記録される必要がある、VulkanなどのグラフィックスAPIでレンダリングを行う場合に便利です。

デフォルトの実装は空です。

レンダリングにQRhi を使用するQSGRenderNode を実装する場合は、QQuickWindow::rhi() を介してQQuickWindow からQRhi オブジェクトを照会します。作業を提出するためのQRhiCommandBuffer を取得するには、commandBuffer() を呼び出す。アクティブなレンダーターゲットに関する情報を照会するには、renderTarget ()を呼び出します。詳細は{Scene Graph - Custom QSGRenderNode} の例を参照してください。

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

[since 6.5] const QMatrix4x4 *QSGRenderNode::projectionMatrix() const

現在の投影行列へのポインタを返します。

render() では、これは RenderState::projectionMatrix() から返されるのと同じ行列です。このゲッターが存在するのは、prepare() にも投影行列を問い合わせる方法があるためです。

最新のグラフィックスAPIや、Qt自身のグラフィックス抽象化レイヤで作業する場合、*projectionMatrix() * *matrix() を均一なバッファにロードしたい場合が多いでしょう。しかし、これはprepare() で行う必要があるため、レンダリングパスの記録外です。そのため、prepare() とrender() の両方で、QSGRenderNode から直接行列を問い合わせることができます。

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

[virtual] QRectF QSGRenderNode::rect() const

この関数は、Qt 6.5 で導入されました。render() が触れている領域の外接矩形をアイテム座標で返します。この値は、flags() がBoundedRectRendering を含む場合にのみ使用され、それ以外の場合は無視されます。

BoundedRectRendering と組み合わせて矩形を報告することは、software バックエンドで特に重要です。そうしないと、シーンにレンダーノードがある場合、フルスクリーン更新がトリガされ、すべての部分更新の最適化がスキップされるからです。

対応するQQuickItem の全領域をカバーするレンダーノードの場合、戻り値は (0, 0, item->width(), item->height()) になります。

注意: シーングラフのノードはQQuickItem ジオメトリに囲まれていないため、アイテムの幅と高さで指定された境界の外側にノードをレンダリングすることも自由です。

flags()も参照してください

[virtual] void QSGRenderNode::releaseResources()

この関数は、このノードによって割り当てられたすべてのカスタム・グラフィックス・リソースを直ちに解放する必要があるときに呼び出されます。ノードが使用中のグラフィックスAPIを通じて直接グラフィックスリソース(バッファ、テクスチャ、レンダーターゲット、フェンスなど)を割り当てていない場合、ここで行うことはありません。

すべてのカスタムリソースの解放に失敗すると、システムによっては、グラフィックスデバイスの損失シナリオで、その後のグラフィックスシステムの再初期化に失敗する可能性があるため、正しくない動作につながる可能性があります。

注意: シーングラフバックエンドによっては、この関数を呼び出さないこともあります。そのため、QSGRenderNode の実装では、デストラクタとreleaseResources()の両方でクリーンアップを実行することが期待されます。

デストラクタとは異なり、releaseResources()を呼び出した後にrender() を呼び出すと、必要なすべてのリソースを再初期化できることが期待されます。

OpenGLの場合、シーングラフのOpenGLコンテキストは、デストラクタとこの関数を呼び出すときの両方が最新になります。

[pure virtual] void QSGRenderNode::render(const QSGRenderNode::RenderState *state)

この関数はレンダラーによって呼び出され、現在使用されているグラフィックスAPI(OpenGL、Direct3Dなど)のコマンドを直接呼び出して、このノードをペイントする必要があります。

有効不透明度はinheritedOpacity() で取得できます。

投影行列はstate で取得でき,モデルビュー行列はmatrix() で取得できます.結合行列は,射影行列にモデルビュー行列を掛けたものになります.シーン内のアイテムの正しいスタッキングは、投影行列によって保証されます。

提供された行列を使用する場合、頂点データの座標系は通常のQQuickItem の規約に従います:左上は (0, 0)、右下は対応するQQuickItem の width() と height() から 1 を引いた値です。例えば、1頂点あたり2浮動小数点(x-y)の座標レイアウトを仮定すると、アイテムの半分をカバーする三角形は、反時計回りで(幅 - 1、高さ - 1)、(0、0)、(0、高さ - 1)と指定できます。

注意: QSGRenderNode は、カスタムの 2D または 2.5D Qt Quick アイテムを実装するための手段として提供されています。真の3DコンテンツをQt Quickシーンに統合するためのものではありません。そのような用途には、QQuickFramebufferObjectQQuickWindow::beforeRendering ()、またはOpenGL以外のAPIに対応した同等のものが適しています。

注: QSGRenderNode は、特にフラグメントの処理能力が制限されているシステムでは、テクスチャベースのアプローチ(QQuickFramebufferObject など)よりも大幅にパフォーマンスが向上します。これは、テクスチャにレンダリングしてからテクスチャ付きの四角形を描画することを避けるためです。むしろ、QSGRenderNode 、シーングラフの他のコマンドと一緒に描画コールを記録することができ、追加のレンダーターゲットや潜在的に高価なテクスチャリングとブレンドを避けることができます。

クリップ情報は、関数が呼び出される前に計算されます。クリッピングを考慮したい実装は、state の情報に基づいて、シザリングまたはステンシルを設定できます。ステンシルバッファは必要なクリップ形状で満たされますが、ステンシルテストを有効にするかどうかは実装次第です。

いくつかのシーングラフバックエンド(特にソフトウェア)は、シザーやステンシルを使用しません。そこでは、クリップ領域は通常のQRegion として提供されます。

レンダリングにQRhi を使用するQSGRenderNode を実装する場合、QQuickWindow::rhi() を介してQQuickWindow からQRhi オブジェクトをクエリします。作業提出用のQRhiCommandBuffer を取得するには、commandBuffer() を呼び出します。アクティブなレンダーターゲットに関する情報を照会するには、renderTarget ()を呼び出します。詳しくは{Scene Graph - Custom QSGRenderNode}の例を参照してください。

Qt 6とそのQRhi-ベースのシーングラフ・レンダラでは、OpenGLが使用中であっても、この関数が呼び出されたときにアクティブ(OpenGL)状態について仮定すべきではありません。この関数が呼び出されたときに、コマンドリスト/バッファにバインドされているパイプラインと動的な状態については、何も仮定しないでください。

Note: 深度書き込みは、無効にすることが期待されます。深度書き込みを有効にすると、使用しているシーングラフのバックエンドやシーンのコンテンツによって、予期しない結果になることがあるので、注意してください。

注意: Qt 6 では、changedStates() の使用は制限されています。詳しくはchangedStates() のドキュメントを参照してください。

いくつかのグラフィックスAPIでは、QRhi を直接使用する場合も含めて、prepare() を再実装するか、QQuickWindow::beforeRendering() シグナルに接続する必要があります。これらは、コマンドバッファにレンダーパスの開始を記録する(Vulkanの場合はvkCmdBeginRenderPass、Metalの場合はMTLRenderCommandEncoderを介してエンコードを開始する)前に呼び出され、発信されます。このようなAPIでは、render()内でコピー操作を記録することはできません。そのような操作は、prepare ()か、(DirectConnectionで)beforeRenderingに接続されたスロットで行ってください。

QSGRendererInterface およびQQuickWindow::rendererInterface()も参照

[since 6.6] QRhiRenderTarget *QSGRenderNode::renderTarget() const

現在のレンダーターゲットを返します。

これは主に、QRhiRenderTargetrenderPassDescriptor またはpixel size にアクセスするQRhi を使用するprepare() およびrender() の実装を有効にするために提供される。

QRhiGraphicsPipeline を構築するには、QRhiRenderPassDescriptor を提供する必要があり、レンダーターゲットから renderPassDescriptor を問い合わせる必要がある。QSGRenderNode しかし、レンダーターゲットは、カスタムQQuickItemQSGRenderNode のライフタイムの間に変更される可能性があることに注意してください。たとえば、アイテムまたはその祖先にlayer.enabled: true を動的に設定するときに何が起こるかを考えてみましょう。これは、ウィンドウに直接レンダリングするのではなく、テクスチャにレンダリングすることをトリガーします。新しいレンダーターゲットは異なるピクセルフォーマットを持つ可能性があり、すでに構築されたグラフィックスパイプラインに互換性がなくなる可能性があります。これは、次のようなロジックで処理できます:

if (m_pipeline && renderTarget()->renderPassDescriptor()->serializedFormat() != m_renderPassFormat) {
    delete m_pipeline;
    m_pipeline = nullptr;
}
if (!m_pipeline) {
    // Build a new QRhiGraphicsPipeline.
    // ...
    // Store the serialized format for fast and simple comparisons later on.
    m_renderPassFormat = renderTarget()->renderPassDescriptor()->serializedFormat();
}

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

commandBuffer()も参照してください

この関数は Qt 6.6 で導入されました。©2024 The Qt Company Ltd. ここに含まれるドキュメントの著作権はそれぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。