ISystemBackdropControllerWithTargets Interface

Reference

Definition

Namespace:: Microsoft.UI.Composition.SystemBackdrops

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.

Edit

Extends the ISystemBackdropController interface with the ability to manage system backdrop targets, their configuration, and state changes.

public interface class ISystemBackdropControllerWithTargets : ISystemBackdropController, IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65537)]
/// [Windows.Foundation.Metadata.Guid(2622946940, 39147, 24457, 173, 151, 218, 213, 127, 195, 12, 140)]
struct ISystemBackdropControllerWithTargets : ISystemBackdropController, IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65537)]
[Windows.Foundation.Metadata.Guid(2622946940, 39147, 24457, 173, 151, 218, 213, 127, 195, 12, 140)]
public interface ISystemBackdropControllerWithTargets : ISystemBackdropController, System.IDisposable

Public Interface ISystemBackdropControllerWithTargets
Implements IDisposable, ISystemBackdropController

Derived: Microsoft.UI.Composition.SystemBackdrops.DesktopAcrylicController

Microsoft.UI.Composition.SystemBackdrops.MicaController

Attributes: ContractVersionAttribute GuidAttribute

Implements: ISystemBackdropController IClosable IDisposable

Remarks

A system backdrop is essentially a CompositionBrush that defines a UI material such as Acrylic or Mica. This brush is drawn by the system compositor. A system backdrop controller is an object that encapsulates both the rendering of the system backdrop material as well as the handling of system policy for the given material. Each material has its own controller.

The ISystemBackdropControllerWithTargets interface provides more granular control of ICompositionSupportsSystemBackdrop targets. Targets may be added and removed at any time. All targets must share the same Compositor. Adding a target that expects a different Compositor will cause an invalid argument exception to be thrown and the new target will not be added.

The ISystemBackdropController interface does not provide a mechanism for you to provide app-specific material policy information, and instead requires the application window object. In contrast, the ISystemBackdropControllerWithTargets interface requires a SystemBackdropConfiguration object that lets you specify your own app-specific material policy.

A system backdrop controller will only render a material if it has been provided a SystemBackdropConfiguration object along with at least one target. If not, it will not render anything. Removing a target will make it stop rendering the material. Removing all targets will disable the controller until at least one target is added.

Properties

State

Gets the current state of the system backdrop controller.

Methods

AddSystemBackdropTarget(ICompositionSupportsSystemBackdrop)	Adds the specified system backdrop target on which to draw the material.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
RemoveAllSystemBackdropTargets()	Removes all system background targets.
RemoveSystemBackdropTarget(ICompositionSupportsSystemBackdrop)	Removes the specified system background target.
SetSystemBackdropConfiguration(SystemBackdropConfiguration)	Sets the app-specific policies to be applied to the system backdrop controller.
SetTarget(CoreWindow, CompositionTarget)	Connects a system backdrop controller to the specified `CoreWindow`. (Inherited from ISystemBackdropController)
SetTarget(WindowId, CompositionTarget)	Connects a system backdrop controller to an `HWND` or `AppWindow` with the specified WindowId. (Inherited from ISystemBackdropController)

Events

StateChanged

Occurs when the state of the system backdrop has changed.

Applies to

Share via