ShaderEffectSource QML Type

特定の Qt Quick アイテムをテクスチャに変換して表示します。詳細...

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

プロパティ

• format : enumeration
• hideSource : bool
• live : bool
• mipmap : bool
• recursive : bool
• samples : int
• sourceItem : Item
• sourceRect : rect
• textureMirroring : enumeration
• textureSize : size
• wrapMode : enumeration

方法

• void scheduleUpdate()

詳細な説明

ShaderEffectSource 型は、sourceItem をテクスチャにレンダリングし、シーン内に表示します。sourceItem は、まるで完全に不透明なルートアイテムであるかのようにテクスチャに描画されます。したがって、sourceItem 自体は非表示であっても、テクスチャ上には表示されます。

ShaderEffectSourceは、次のように使用できます：

• ShaderEffect 内のテクスチャソースとして使用できます。これにより、任意の Qt Quick アイテムに適用できます。
• 複雑なアイテムのキャッシュとして。複雑なアイテムをテクスチャに一度レンダリングしておけば、フレームごとにそのアイテムを再度レンダリングすることなく、自由にアニメーションさせることができます。
• 不透明度レイヤーとして。ShaderEffectSource を使用すると、各アイテムを個別に処理するのではなく、アイテムをグループとしてまとめて不透明度を適用できます。

import QtQuick 2.0

Rectangle {
    width: 200
    height: 100
    gradient: Gradient {
        GradientStop { position: 0; color: "white" }
        GradientStop { position: 1; color: "black" }
    }
    Row {
        opacity: 0.5
        Item {
            id: foo
            width: 100; height: 100
            Rectangle { x: 5; y: 5; width: 60; height: 60; color: "red" }
            Rectangle { x: 20; y: 20; width: 60; height: 60; color: "orange" }
            Rectangle { x: 35; y: 35; width: 60; height: 60; color: "yellow" }
        }
        ShaderEffectSource {
            width: 100; height: 100
            sourceItem: foo
        }
    }
}

ShaderEffectSource タイプは、マウスやキーボードの入力をsourceItem にリダイレクトしません。visible をfalseに設定するか、opacity を0に設定してsourceItem を非表示にすると、入力に反応しなくなります。ShaderEffectSourceがsourceItem の代わりとなる場合、通常はsourceItem を非表示にしながらも入力を処理したいものです。そのためには、hideSource プロパティを使用できます。

ShaderEffectSource とMultiEffect を組み合わせることができます：

• 複数のエフェクトで同じソースアイテムを使用し、その内容を変更しないようにするには。
• ShaderEffectSource.sourceRect を使用して、ソースアイテムの一部のみを使用する場合。
• ShaderEffectSource.textureSize プロパティを使用して、ソースアイテムの解像度を下げる（例：パフォーマンス向上のため）。

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

format : enumeration

このプロパティは、バッキングテクスチャの形式を定義します。このプロパティを変更するのは、そのアイテムがShaderEffect のソーステクスチャとして使用される場合に最も意味があります。

hideSource : bool

このプロパティが true の場合、sourceItem は非表示になりますが、テクスチャ内には引き続きレンダリングされます。visible を false に設定してsourceItem を非表示にするのとは異なり、このプロパティを true に設定しても、マウスやキーボードからの入力がsourceItem に届くのを妨げることはありません。このプロパティは、ShaderEffectSource がsourceItem の上にアンカーされ、それを置き換えることを意図している場合に役立ちます。

live : bool

このプロパティが true の場合、sourceItem が更新されるたびにテクスチャも更新されます。そうでない場合、sourceItem に新しいアイテムが割り当てられたとしても、テクスチャは固定された画像のままになります。このプロパティのデフォルト値は true です。

mipmap : bool

このプロパティが true の場合、そのテクスチャに対してミップマップが生成されます。

recursive : bool

ShaderEffectSource がそれ自体に依存関係を持つ場合は、このプロパティをtrueに設定します。ShaderEffectSourcesは依存チェーンを形成しており、あるShaderEffectSource が別の のsourceItem の一部となる場合があります。このチェーンにループが存在する場合、ShaderEffectSource がソースとして使用しているのと同じテクスチャにレンダリングしようとしてしまう可能性があり、これはOpenGLでは許可されていません。 このプロパティを true に設定すると、ShaderEffectSource が前のフレームのテクスチャのコピーを保持できるように、追加のテクスチャが割り当てられます。これにより、あるテクスチャにレンダリングを行いながら、前のフレームのテクスチャをソースとして使用することが可能になります。

このプロパティとlive の両方をtrueに設定すると、シーングラフは継続的にレンダリングされます。ShaderEffectSource はそれ自体に依存しているため、更新されると即座に再び「ダーティ」状態になります。

samples : int

このプロパティを使用すると、マルチサンプリングによるレンダリングを要求することができます。

デフォルトでは、使用中のシーングラフレンダラーおよび基盤となるグラフィックスAPIがこれをサポートしていることを前提として、ウィンドウ全体でマルチサンプリングが有効になっている場合は、常にマルチサンプリングが有効になります。

このプロパティの値を 2、4 などに設定することで、シーン全体に対してマルチサンプリングを有効にすることなく、シーンの一部に対してマルチサンプリングによるレンダリングを要求することができます。これにより、マルチサンプリングは指定されたサブツリーにのみ適用されるため、シーンの他の部分にはマルチサンプリングが適用されないことから、パフォーマンスが大幅に向上する可能性があります。

sourceItem : Item

このプロパティには、テクスチャにレンダリングされるアイテムが格納されます。live がtrueの状態でこれをnullに設定すると、テクスチャリソースが解放されます。

sourceRect : rect

このプロパティは、sourceItem のどの矩形領域をテクスチャにレンダリングするかを定義します。ソースとなる矩形は、sourceItem 自体よりも大きくてもかまいません。矩形がnullの場合（これがデフォルトです）、sourceItem 全体がテクスチャにレンダリングされます。

textureMirroring : enumeration

このプロパティは、生成された OpenGL テクスチャのミラーリング方法を定義します。デフォルト値は `ShaderEffectSource.MirrorVertically` です。ShaderEffect で指定されるようなカスタムシェーダーから生成されたテクスチャに直接アクセスする場合、カスタムミラーリングが役立つことがあります。ミラーリングは、ShaderEffectSource アイテム自体の UI 上の表示には影響しません。

textureSize : size

このプロパティには、テクスチャの指定されたピクセルサイズが格納されます。空の場合（これがデフォルトです）、ソース矩形のサイズが使用されます。

wrapMode : enumeration

このプロパティは、テクスチャに関連付けられた OpenGL のラップモードを定義します。このプロパティを変更するのは、そのアイテムが「ShaderEffect 」のソーステクスチャとして使用される場合に最も意味があります。

デフォルト値は `ShaderEffectSource.ClampToEdge` です。

メソッドのドキュメント

void scheduleUpdate()

次のフレームに向けてテクスチャの再描画をスケジュールします。live がfalseのときにテクスチャを更新する場合にこれを使用してください。