RenderPass QML Type

3Dコンテンツをレンダリングするためのカスタムレンダーパスを定義します。詳細...

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

• augmentShader : url
• clearColor : color
• commands : list<RenderCommand>
• depthClearValue : real
• materialMode : RenderPass::MaterialModes
• overrideMaterial : Material
• passMode : RenderPass::PassMode
• renderTargetFlags : RenderPass::RenderTargetFlags
• stencilClearValue : int

詳細な説明

RenderPass は、レンダリングのステップと、そこに書き込まれるレンダリングターゲットを定義します。これは、以下の 3 つの要素の組み合わせです:

• レンダリング先— 『commands 』内でColorAttachment またはDepthTextureAttachment コマンドとして宣言された、1つまたは複数の出力テクスチャ。
• 何をレンダリングするか— パスが描画するシーンオブジェクト。これは `RenderablesFilter ` コマンドによって制御されます。同じレンダリングターゲット内での作業の細分化は、`SubRenderPass ` コマンドを使用して記述されます。
• レンダリング方法— `materialMode ` コマンドおよび `PipelineStateOverride ` コマンドです。

RenderPassは、View3D またはNode の子として配置されたときに、そのシーンに対して有効になります。

次の例では、すべてのシーンオブジェクトをカスタムテクスチャにレンダリングする単純なオフスクリーンパスを設定しています。このテクスチャは、マテリアルやSimpleQuadRenderer で利用できます。

import QtQuick3D

View3D {
    // Declare the off-screen color buffer
    RenderPassTexture {
        id: myColorTexture
        format: RenderPassTexture.RGBA8
    }

    // The render pass: where + what + how
    RenderPass {
        id: myRenderPass
        commands: [
            // Where: attach the texture as the color output
            ColorAttachment {
                name: "color0"
                target: myColorTexture
            },
            // What: render all objects into it
            RenderablesFilter {
                renderableTypes: RenderablesFilter.Opaque | RenderablesFilter.Transparent
            }
        ]
    }
}

シェーダーへのデータの公開

エフェクトやカスタムマテリアルと同様に、RenderPassはユーザー定義のプロパティをシェーダーに対して自動的に公開・更新します。RenderPassのサブタイプで宣言されたQMLプロパティは、すべてシェーダー内でユニフォームとして利用可能になります。

関連項目： SubRenderPass 、RenderOutputProvider 、およびRenderablesFilter 。

プロパティのドキュメント

augmentShader : url

このプロパティは、materialMode がAugmentMaterial に設定されている場合、レンダリングパスのオーグメントシェーダーのURLを保持します。

シェーダーファイルには、以下のシグネチャを持つ関数が含まれている必要があります。

void MAIN_FRAGMENT_AUGMENT() {
    // Custom shader code here
}

この関数は、このレンダーパスでレンダリングされるオブジェクトが使用しているマテリアルの既存のフラグメントシェーダーと組み合わされます。これにより、ユーザーは既存のマテリアルシェーダーをカスタムコードで拡張できるようになります。

clearColor : color [default: Qt.black]

このプロパティは、レンダリングパスに適用されるクリアカラーを指定します。

commands : list<RenderCommand>

このプロパティには、レンダリングパス用のレンダリングコマンドのリストが格納されます。

リスト内のコマンドは、リストに表示される順序で実行されます。

関連項目： SubRenderPass 、PipelineStateOverride 、RenderablesFilter 、RenderPassTexture 、ColorAttachment 、DepthTextureAttachment 、DepthStencilAttachment 、AddDefine 、およびrenderTargetBlend 。

depthClearValue : real [default: 1.0]

このプロパティには、レンダリングパスの「深度クリア」値が格納されます。

materialMode : RenderPass::MaterialModes [default: RenderPass.OriginalMaterial]

このパスへのレンダリング時に、オブジェクトのマテリアルがどのように扱われるかを制御します。

overrideMaterial : Material

このプロパティは、materialMode がOverrideMaterial に設定されている場合、レンダリングパスのオーバーライドマテリアルを保持します。

passMode : RenderPass::PassMode [default: RenderPass.UserPass]

このプロパティは、レンダリングパスのパスモードを保持します。

標準のユーザーレンダリングパスに加え、Qt Quick 3D では、スカイボックスや 2D アイテムをレンダリングするための内部レンダリングパスをユーザーが手動でトリガーすることも可能です。

renderTargetFlags : RenderPass::RenderTargetFlags [default: RenderPass.None]

このプロパティは、レンダリングパスに対するレンダリングターゲットのフラグを保持します。これらのフラグは、各フレームの開始時および終了時にレンダリングターゲットの内容がどのように処理されるかに影響を与えます。

QRhiTextureRenderTarget::Flagsも参照してください 。

stencilClearValue : int [default: 0]

このプロパティには、レンダーパスに対するステンシルクリア値が格納されます。