CompositionEffectSourceParameter CompositionEffectSourceParameter CompositionEffectSourceParameter 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 : sealed class CompositionEffectSourceParameter : IGraphicsEffectSource, ICompositionEffectSourceParameterpublic sealed class CompositionEffectSourceParameter : IGraphicsEffectSource, ICompositionEffectSourceParameterPublic NotInheritable Class CompositionEffectSourceParameter Implements IGraphicsEffectSource, ICompositionEffectSourceParameter// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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) CompositionEffectSourceParameter(String) CompositionEffectSourceParameter(String) CompositionEffectSourceParameter(String)

Creates an instance of CompositionEffectSourceParameter.

public : CompositionEffectSourceParameter(PlatForm::String name)public CompositionEffectSourceParameter(String name)Public Sub New(name As String)// This API is not available in Javascript.
Parameters
name
PlatForm::String String String String

The name for the CompositionEffectSourceParameter instance.

Properties

Name Name Name Name

The name associated with the effect source.

public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The name associated with the effect source.

See Also