XamlCompositionBrush Class

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.UI.Media

Assembly:: Microsoft.Toolkit.Uwp.UI.Media.dll

Package:: Microsoft.Toolkit.Uwp.UI.Media v6.1.1

Package:: Microsoft.Toolkit.Uwp.UI.Media v7.0.2

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public sealed class XamlCompositionBrush : Microsoft.Toolkit.Uwp.UI.Media.XamlCompositionEffectBrushBase

type XamlCompositionBrush = class
    inherit XamlCompositionEffectBrushBase

Public NotInheritable Class XamlCompositionBrush
Inherits XamlCompositionEffectBrushBase

Inheritance: Windows.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 Windows.UI.Xaml.Media.Brush. Use this method to reuse the same effects pipeline on a different Windows.System.DispatcherQueue
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