CompositionEffectFactory
CompositionEffectFactory
CompositionEffectFactory
CompositionEffectFactory
Class
Definition
Creates a composition object that contains a Win2D effect description format in the Microsoft.Graphics.Canvas.Effects namespace.
Note
Effects that are not supported are marked as [NoComposition] in the Win2D API Reference for effects namespace.
public : sealed class CompositionEffectFactory : CompositionObject, ICompositionEffectFactorypublic sealed class CompositionEffectFactory : CompositionObject, ICompositionEffectFactoryPublic NotInheritable Class CompositionEffectFactory Inherits CompositionObject Implements ICompositionEffectFactory// This API is not available in Javascript.
- Inheritance
-
CompositionEffectFactoryCompositionEffectFactoryCompositionEffectFactoryCompositionEffectFactory
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Examples
// Create an effect description
GaussianBlurEffect blurEffect = new GaussianBlurEffect()
{
Name = "Blur",
BlurAmount = 1.0f,
BorderMode = EffectBorderMode.Hard,
Optimization = EffectOptimization.Balanced
};
CompositionEffectFactory blurEffectFactory = _compositor.CreateEffectFactory(blurEffect);
Remarks
A composition effect is a graph of operations that define how to produce graphical content based on composition surfaces; for example, the pixel content of images. Effects are applied to visuals in the tree and can reference existing surfaces.
See the remarks section of CompositionEffectBrush for information on creating and using effects.
Properties
ExtendedError ExtendedError ExtendedError ExtendedError
An extended error code for the result of a call to CreateBrush.
public : HResult ExtendedError { get; }public Exception ExtendedError { get; }Public ReadOnly Property ExtendedError As Exception// This API is not available in Javascript.
- Value
- HResult Exception Exception Exception
An extended error code for the result of a call to CreateBrush.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
LoadStatus LoadStatus LoadStatus LoadStatus
The load status of a CreateBrush call.
public : CompositionEffectFactoryLoadStatus LoadStatus { get; }public CompositionEffectFactoryLoadStatus LoadStatus { get; }Public ReadOnly Property LoadStatus As CompositionEffectFactoryLoadStatus// This API is not available in Javascript.
- Value
- CompositionEffectFactoryLoadStatus CompositionEffectFactoryLoadStatus CompositionEffectFactoryLoadStatus CompositionEffectFactoryLoadStatus
The load status of a CreateBrush call.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
Methods
CreateBrush() CreateBrush() CreateBrush() CreateBrush()
Creates an instance of CompositionEffectBrush with the effect definition and animatable properties contained in the CompositionEffectFactory object.
public : CompositionEffectBrush CreateBrush()public CompositionEffectBrush CreateBrush()Public Function CreateBrush() As CompositionEffectBrush// This API is not available in Javascript.
Returns the created CompositionEffectBrush object.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|