Compositor.CreateHostBackdropBrush Method

Definition

Creates an instance of CompositionBackdropBrush that samples from the area behind the visual, before the window is drawn.

public:
 virtual CompositionBackdropBrush ^ CreateHostBackdropBrush() = CreateHostBackdropBrush;
CompositionBackdropBrush CreateHostBackdropBrush();
public CompositionBackdropBrush CreateHostBackdropBrush();
function createHostBackdropBrush()
Public Function CreateHostBackdropBrush () As CompositionBackdropBrush

Returns

Returns the created CompositionBackdropBrush.

Windows requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

The standard backdrop brush samples the area immediately behind the visual where it is used. The host backdrop brush tells the compositor to sample from the area behind the visual, before the window is drawn. By default, the host backdrop brush is translucent and it hit-tests as opaque. The app cannot read the pixel data back.

The transparency of the host backdrop brush is a property the user can control from Settings or by using power policies.

Applies to