CompositionEffectSourceParameter Class

Definition

Namespace:

Windows.UI.Composition

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.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Composition.ICompositionEffectSourceParameterFactory, 131072, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class CompositionEffectSourceParameter final : IGraphicsEffectSource

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Composition.ICompositionEffectSourceParameterFactory), 131072, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
public sealed class CompositionEffectSourceParameter : IGraphicsEffectSource

Public NotInheritable Class CompositionEffectSourceParameter
Implements IGraphicsEffectSource

Inheritance

Object Platform::Object IInspectable CompositionEffectSourceParameter

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IGraphicsEffectSource

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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.

See also

• Composition Brushes Overview
• Composition Effects Overview