Compositor.CreateBackdropBrush Method

Definition

Namespace:
Windows.UI.Composition
Edit

Creates an instance of CompositionBackdropBrush.

Equivalent WinUI method: Microsoft.UI.Composition.Compositor.CreateBackdropBrush.

public:
 virtual CompositionBackdropBrush ^ CreateBackdropBrush() = CreateBackdropBrush;
CompositionBackdropBrush CreateBackdropBrush();
public CompositionBackdropBrush CreateBackdropBrush();
function createBackdropBrush()
Public Function CreateBackdropBrush () As CompositionBackdropBrush

Returns

CompositionBackdropBrush

Returns the created CompositionBackdropBrush object.

Windows 10 requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Examples

// Create an effect description 

GaussianBlurEffect blurEffect = new GaussianBlurEffect() 
{ 
  Name = "Blur", 
  BlurAmount = 1.0f, 
  BorderMode = EffectBorderMode.Hard, 
  Optimization = EffectOptimization.Balanced 
}; 

blurEffect.Source = new CompositionEffectSourceParameter("source"); 

CompositionEffectFactory blurEffectFactory = _compositor.CreateEffectFactory(blurEffect); 

CompositionEffectBrush blurBrush = blurEffectFactory.CreateBrush(); 

// Create a BackdropBrush and bind it to the EffectSourceParameter "source" 
CompositionBackdropBrush backdropBrush = _compositor.CreateBackdropBrush(); 

blurBrush.SetSourceParameter("source", backdropBrush);

Remarks

See the remarks section of CompositionEffectBrush for information on creating and using effects.

Applies to