CompositionEffectSourceParameter Class

Definition

Used to declare an arbitrary name (a String) to be associated with a CompositionBrush (the “effect source”). The association of the given name and the effect source occurs when the SetSourceParameter method of a CompositionEffectBrush is called.

public ref class CompositionEffectSourceParameter sealed : IGraphicsEffectSource
/// [Windows.Foundation.Metadata.Activatable(Microsoft.UI.Composition.ICompositionEffectSourceParameterFactory, 65536, "Microsoft.Foundation.LiftedContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class CompositionEffectSourceParameter final : IGraphicsEffectSource
[Windows.Foundation.Metadata.Activatable(typeof(Microsoft.UI.Composition.ICompositionEffectSourceParameterFactory), 65536, "Microsoft.Foundation.LiftedContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.LiftedContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class CompositionEffectSourceParameter : IGraphicsEffectSource
Public NotInheritable Class CompositionEffectSourceParameter
Implements IGraphicsEffectSource
Inheritance
CompositionEffectSourceParameter
Attributes
Windows.Foundation.Metadata.ActivatableAttribute Windows.Foundation.Metadata.ContractVersionAttribute Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.WebHostHiddenAttribute
Implements
Windows.Graphics.Effects.IGraphicsEffectSource

Examples

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

blurEffect.Source = new CompositionEffectSourceParameter("source"); 

Remarks

See the remarks section of CompositionEffectBrush for information on creating and using effects.

Constructors

CompositionEffectSourceParameter(String)

Creates an instance of CompositionEffectSourceParameter.

Properties

Name

The name associated with the effect source.

Applies to

See also