CompositionEffectFactory 类

定义

命名空间:

Microsoft.UI.Composition

创建包含 Microsoft.Graphics.Canvas.Effects 命名空间中的 Win2D 效果描述格式的合成对象，该对象 (WinAppSDK (WinUI 3) / UWP (WinUI 2) ) 。

注意

不支持的效果在效果命名空间的 Win2D API 参考 中标记为 [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 的 Compositor。 (继承自 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