CompositionEffectFactory クラス

定義

名前空間:

Microsoft.UI.Composition

Microsoft.Graphics.Canvas.Effects 名前空間 (WinAppSDK (WinUI 3)UWP (WinUI 2) / ) の Win2D 効果の説明形式を含むコンポジション オブジェクトを作成します。

注意

サポートされていない効果は、 Win2D API Reference for effects 名前空間で [NoComposition] とマークされます。

public ref class CompositionEffectFactory sealed : CompositionObject

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class CompositionEffectFactory final : CompositionObject

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class CompositionEffectFactory : CompositionObject

Public NotInheritable Class CompositionEffectFactory
Inherits CompositionObject

継承

Object Platform::Object IInspectable CompositionObject CompositionEffectFactory

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

例

// Create an effect description 
GaussianBlurEffect blurEffect = new GaussianBlurEffect() 
{ 
    Name = "Blur", 
    BlurAmount = 1.0f, 
    BorderMode = EffectBorderMode.Hard, 
    Optimization = EffectOptimization.Balanced 
}; 

CompositionEffectFactory blurEffectFactory = _compositor.CreateEffectFactory(blurEffect); 

注釈

コンポジション効果は、コンポジションサーフェスに基づいてグラフィカルコンテンツを生成する方法を定義する操作のグラフです。たとえば、画像のピクセル コンテンツなどです。 効果はツリー内のビジュアルに適用され、既存のサーフェスを参照できます。

効果の作成と使用については、 CompositionEffectBrush の解説セクションを参照してください。

プロパティ

Comment	CompositionObject に関連付ける文字列。 (継承元 CompositionObject)
Compositor	この CompositionObject の作成に使用するコンポジター。 (継承元 CompositionObject)
DispatcherQueue	CompositionObject の DispatcherQueue を取得します。 (継承元 CompositionObject)
ExtendedError	CreateBrush の呼び出しの結果の拡張エラー コード。
ImplicitAnimations	このオブジェクトにアタッチされている暗黙的なアニメーションのコレクション。 (継承元 CompositionObject)
LoadStatus	CreateBrush 呼び出しの読み込み状態。
Properties	CompositionObject に関連付けられているプロパティのコレクション。 (継承元 CompositionObject)

メソッド

Close()	CompositionObject を閉じ、システム リソースを解放します。 (継承元 CompositionObject)
CreateBrush()	CompositionEffectFactory オブジェクトに含まれる効果の定義とアニメーション化可能なプロパティを使用して CompositionEffectBrush のインスタンスを作成します。
Dispose()	アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。 (継承元 CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	アニメーション化できるプロパティを定義します。 (継承元 CompositionObject)
StartAnimation(String, CompositionAnimation)	アニメーションをオブジェクトの指定したプロパティに接続し、アニメーションを開始します。 (継承元 CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	アニメーションをオブジェクトの指定したプロパティに接続し、アニメーションを開始します。 (継承元 CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	アニメーション グループを開始します。 CompositionObject の StartAnimationGroup メソッドを使用すると、CompositionAnimationGroup を開始できます。 グループ内のすべてのアニメーションは、オブジェクトで同時に開始されます。 (継承元 CompositionObject)
StopAnimation(String)	指定したプロパティからアニメーションを切断し、アニメーションを停止します。 (継承元 CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	アニメーション グループを停止します。 (継承元 CompositionObject)
TryGetAnimationController(String)	指定したプロパティで実行されているアニメーションの AnimationController を返します。 (継承元 CompositionObject)

こちらもご覧ください

• CompositionObject
• コンポジション ブラシの概要
• コンポジション効果の概要
• IClosable