AcrylicBrush Class

Definition

Namespace:

Microsoft.UI.Xaml.Media

Paints an area with a semi-transparent material that uses multiple effects including blur and a noise texture.

/// [Microsoft.UI.Xaml.CustomAttributes.MUXHasCustomActivationFactory]
/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class AcrylicBrush : XamlCompositionBrushBase

[Microsoft.UI.Xaml.CustomAttributes.MUXHasCustomActivationFactory]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class AcrylicBrush : XamlCompositionBrushBase

Public Class AcrylicBrush
Inherits XamlCompositionBrushBase

Inheritance

Object IInspectable DependencyObject Brush XamlCompositionBrushBase AcrylicBrush

Attributes

Microsoft.UI.Xaml.CustomAttributes.MUXHasCustomActivationFactoryAttribute Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackAttribute Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodNameAttribute MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Acrylic material.

Open the WinUI 3 Gallery app and see the AcrylicBrush in action.

The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Constructors

AcrylicBrush()

Initializes a new instance of the AcrylicBrush class.

Properties

AlwaysUseFallback	Gets or sets a value that specifies whether the brush is forced to the solid fallback color.
AlwaysUseFallbackProperty	Identifies the AlwaysUseFallback dependency property.
CompositionBrush	Gets or sets the CompositionBrush used by this XAML brush. (Inherited from XamlCompositionBrushBase)
Dispatcher	Always returns null in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the DispatcherQueue that this object is associated with. The DispatcherQueue represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
FallbackColor	The color to use for rendering in case the CompositionBrush can't be rendered. (Inherited from XamlCompositionBrushBase)
Opacity	Gets or sets the degree of opacity of a Brush. (Inherited from Brush)
RelativeTransform	Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush)
TintColor	Gets or sets the color tint for the semi-transparent acrylic material.
TintColorProperty	Identifies the TintColor dependency property.
TintLuminosityOpacity	Gets or sets the degree of opacity of the color's luminosity tint.
TintLuminosityOpacityProperty	Identifies the TintLuminosityOpacity dependency property.
TintOpacity	Gets or sets the degree of opacity of the color tint.
TintOpacityProperty	Identifies the TintOpacity dependency property.
TintTransitionDuration	Gets or sets the length of the automatic transition animation used when the TintColor changes.
TintTransitionDurationProperty	Identifies the TintTransitionDuration dependency property.
Transform	Gets or sets the transformation that is applied to the brush. (Inherited from Brush)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
OnConnected()	Invoked when a brush is first used on screen to paint an element. When implemented in a derived class, you can create a CompositionBrush instance and provide it to the framework by setting the CompositionBrush property. OnDisconnected will be called when the brush is no longer being used to paint any elements. (Inherited from XamlCompositionBrushBase)
OnDisconnected()	Invoked when the brush is no longer being used to paint any elements. When implemented in a derived class, you can safely dispose of the compostion brush and other composition resources. OnConnected will be called again if the brush is later used to paint any elements after being disconnected. (Inherited from XamlCompositionBrushBase)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from Brush)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)	When overridden in a derived class, defines a property that can be animated. (Inherited from Brush)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

See also

• Acrylic material overview