PipelineBrush Class

Definition

Namespace:

Microsoft.Toolkit.Uwp.UI.Media

Assembly:

Microsoft.Toolkit.Uwp.UI.Media.dll

Package:

Microsoft.Toolkit.Uwp.UI.Media v7.1.2

A Windows.UI.Xaml.Media.Brush that renders a customizable Composition/Win2D effects pipeline

C#

[Windows.UI.Xaml.Markup.ContentProperty(Name="Effects")]
public sealed class PipelineBrush : Microsoft.Toolkit.Uwp.UI.Media.XamlCompositionEffectBrushBase

Inheritance

Windows.UI.Xaml.Media.XamlCompositionBrushBase

XamlCompositionEffectBrushBase

PipelineBrush

Attributes

Windows.UI.Xaml.Markup.ContentPropertyAttribute

Constructors

PipelineBrush()

Fields

EffectsProperty

Identifies the dependency property.

Properties

Effects	Gets or sets the collection of effects to use in the current pipeline.
IsEnabled	Gets or sets a value indicating whether the current brush is using the provided pipeline, or the fallback color. (Inherited from XamlCompositionEffectBrushBase)
Source	Gets or sets the source for the current pipeline (defaults to a BackdropSourceExtension with Windows.UI.Xaml.Media.AcrylicBackgroundSource.Backdrop source).

Methods

OnBrushRequested()	A method that builds and returns the PipelineBuilder pipeline to use in the current instance. This method can also be used to store any needed EffectSetter<T> or EffectAnimation<T> instances in local fields, for later use (they will need to be called upon Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush). (Inherited from XamlCompositionEffectBrushBase)
OnCompositionBrushUpdated()	Invoked whenever the Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush property is updated. (Inherited from XamlCompositionEffectBrushBase)
OnConnected()	(Inherited from XamlCompositionEffectBrushBase)
OnDisconnected()	(Inherited from XamlCompositionEffectBrushBase)
OnEnabledToggled(Boolean)	Updates the Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush property depending on the input value. (Inherited from XamlCompositionEffectBrushBase)
OnPipelineRequested()	A method that builds and returns the PipelineBuilder pipeline to use in the current instance. This method can also be used to store any needed EffectSetter<T> or EffectAnimation<T> instances in local fields, for later use (they will need to be called upon Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush). (Inherited from XamlCompositionEffectBrushBase)

Applies to