AcrylicBrush 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 XamlCompositionBrush that implements an acrylic effect with customizable parameters

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

type AcrylicBrush = class
    inherit XamlCompositionEffectBrushBase

Public NotInheritable Class AcrylicBrush
Inherits XamlCompositionEffectBrushBase

Inheritance: Windows.UI.Xaml.Media.XamlCompositionBrushBase

XamlCompositionEffectBrushBase
AcrylicBrush

Constructors

AcrylicBrush()

Fields

BackgroundSourceProperty	Identifies the BackgroundSource dependency property.
BlurAmountProperty	Identifies the BlurAmount dependency property.
TextureUriProperty	Identifies the TextureUri dependency property.
TintColorProperty	Identifies the TintColor dependency property.
TintOpacityProperty	Identifies the TintOpacity dependency property.

Properties

BackgroundSource	Gets or sets the background source mode for the effect (the default is Windows.UI.Xaml.Media.AcrylicBackgroundSource.Backdrop).
BlurAmount	Gets or sets the blur amount for the effect (must be a positive value)
IsEnabled	Gets or sets a value indicating whether the current brush is using the provided pipeline, or the fallback color. (Inherited from XamlCompositionEffectBrushBase)
TextureUri	Gets or sets the Uri for the texture to use
TintColor	Gets or sets the tint for the effect
TintOpacity	Gets or sets the tint opacity factor for the effect (default is 0.5, must be in the [0, 1] range)

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