DesktopAcrylicController Class

Definition

Namespace:

Microsoft.UI.Composition.SystemBackdrops

Manages rendering and system policy for the background acrylic material.

public ref class DesktopAcrylicController sealed : ISystemBackdropControllerWithTargets, IClosableNotifier, IClosable

/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DesktopAcrylicController final : ISystemBackdropControllerWithTargets, IClosableNotifier, IClosable

[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DesktopAcrylicController : ISystemBackdropControllerWithTargets, IClosableNotifier, System.IDisposable

function DesktopAcrylicController()

Public NotInheritable Class DesktopAcrylicController
Implements IClosableNotifier, IDisposable, ISystemBackdropControllerWithTargets

Inheritance

Object Platform::Object IInspectable DesktopAcrylicController

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

ISystemBackdropController IClosable IDisposable ISystemBackdropControllerWithTargets IClosableNotifier

Remarks

This class encapsulates both the rendering of the system backdrop material as well as the handling of system policy for the background acrylic material.

Background acrylic reveals the desktop wallpaper and other windows that are behind the currently active app.

Constructors

DesktopAcrylicController()

Initializes a new instance of the DesktopAcrylicController class.

Properties

FallbackColor	Gets or sets the solid color to use when system conditions prevent rendering the acrylic material.
IsClosed	Gets a value that indicates whether the object is closed (disposed).
Kind	Gets or sets a value that indicates what variant of Acrylic material is used.
LuminosityOpacity	Gets or sets the degree of opacity of the color's luminosity.
State	Gets the current state of the system backdrop controller.
TintColor	Gets or sets the color tint for the background acrylic material.
TintOpacity	Gets or sets the degree of opacity of the color tint.

Methods

AddSystemBackdropTarget(ICompositionSupportsSystemBackdrop)	Adds the specified system backdrop target.
Close()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
IsSupported()	Determines whether the acrylic material is supported on the current operating system.
RemoveAllSystemBackdropTargets()	Removes all system background targets.
RemoveSystemBackdropTarget(ICompositionSupportsSystemBackdrop)	Removes the specified system background target.
ResetProperties()	Resets any customized properties to their system defaults and reverts to automatic light/dark theme handling.
SetSystemBackdropConfiguration(SystemBackdropConfiguration)	Sets the app-specific policies to be applied to the system backdrop controller.
SetTarget(CoreWindow, CompositionTarget)	Connects this system backdrop controller to the specified CoreWindow.
SetTarget(WindowId, CompositionTarget)	Connects this system backdrop controller to an HWND or AppWindow with the specified WindowId.

Events

Closed	Occurs when the object has been closed (disposed), after the FrameworkClosed event, to notify the app that the object is closed.
FrameworkClosed	Occurs when the object has been closed (disposed), before the Closed event, to notify the framework (such as XAML) that the object is closed.
StateChanged	Occurs when the state of the system backdrop has changed.

See also

• ISystemBackdropController
• DesktopAcrylicBackdrop
• Materials
• Acrylic