XamlCompositionBrush Class

Definition

Namespace:

CommunityToolkit.WinUI.UI.Media

Assembly:

CommunityToolkit.WinUI.UI.Media.dll

Package:

CommunityToolkit.WinUI.UI.Media v7.0.3

A simple class that can be used to quickly create XAML brushes from arbitrary PipelineBuilder pipelines

C#

public sealed class XamlCompositionBrush : CommunityToolkit.WinUI.UI.Media.XamlCompositionEffectBrushBase

Inheritance

Microsoft.UI.Xaml.Media.XamlCompositionBrushBase

XamlCompositionEffectBrushBase

XamlCompositionBrush

Constructors

XamlCompositionBrush(PipelineBuilder)

Initializes a new instance of the XamlCompositionBrush class.

Properties

IsEnabled	Gets or sets a value indicating whether the current brush is using the provided pipeline, or the fallback color. (Inherited from XamlCompositionEffectBrushBase)
Pipeline	Gets the PipelineBuilder pipeline for the current instance

Methods

Bind<T>(EffectAnimation<T>, XamlEffectAnimation<T>)	Binds an EffectAnimation<T> to the composition brush in the current instance
Bind<T>(EffectSetter<T>, XamlEffectSetter<T>)	Binds an EffectSetter<T> to the composition brush in the current instance
Clone()	Clones the current instance by rebuilding the source Microsoft.UI.Xaml.Media.Brush. Use this method to reuse the same effects pipeline on a different Microsoft.UI.Dispatching.DispatcherQueue
OnCompositionBrushUpdated()	Invoked whenever the Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush property is updated. (Inherited from XamlCompositionEffectBrushBase)
OnConnected()	(Inherited from XamlCompositionEffectBrushBase)
OnDisconnected()	(Inherited from XamlCompositionEffectBrushBase)
OnEnabledToggled(Boolean)	Updates the Microsoft.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 Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush). (Inherited from XamlCompositionEffectBrushBase)

Applies to