PipelineBuilder Class

Definition

A class that allows to build custom effects pipelines and create Windows.UI.Composition.CompositionBrush instances from them

public sealed class PipelineBuilder
type PipelineBuilder = class
Public NotInheritable Class PipelineBuilder
Inheritance
PipelineBuilder

Methods

AsBrush()

Creates a new XamlCompositionBrush from the current effects pipeline

AttachAsync(UIElement, UIElement)

Builds the current pipeline and creates a Windows.UI.Composition.SpriteVisual that is applied to the input Windows.UI.Xaml.UIElement

Blend(PipelineBuilder, BlendEffectMode, Placement)

Blends two pipelines using a BlendEffect instance with the specified mode

Blur(Single, EffectAnimation<Single>, EffectBorderMode, EffectOptimization)

Adds a new Microsoft.Graphics.Canvas.Effects.GaussianBlurEffect to the current pipeline

Blur(Single, EffectBorderMode, EffectOptimization)

Adds a new Microsoft.Graphics.Canvas.Effects.GaussianBlurEffect to the current pipeline

Blur(Single, EffectSetter<Single>, EffectBorderMode, EffectOptimization)

Adds a new Microsoft.Graphics.Canvas.Effects.GaussianBlurEffect to the current pipeline

BuildAsync()

Builds a Windows.UI.Composition.CompositionBrush instance from the current effects pipeline

CrossFade(PipelineBuilder, Single)

Cross fades two pipelines using an Microsoft.Graphics.Canvas.Effects.CrossFadeEffect instance

CrossFade(PipelineBuilder, Single, EffectAnimation<Single>)

Cross fades two pipelines using an Microsoft.Graphics.Canvas.Effects.CrossFadeEffect instance

CrossFade(PipelineBuilder, Single, EffectSetter<Single>)

Cross fades two pipelines using an Microsoft.Graphics.Canvas.Effects.CrossFadeEffect instance

CrossFade(PipelineBuilder, Single, String)

Cross fades two pipelines using an Microsoft.Graphics.Canvas.Effects.CrossFadeEffect instance

Effect(Func<IGraphicsEffectSource,IGraphicsEffectSource>, IEnumerable<String>, IEnumerable<BrushProvider>)

Applies a custom effect to the current pipeline

Effect(Func<IGraphicsEffectSource,Task<IGraphicsEffectSource>>, IEnumerable<String>, IEnumerable<BrushProvider>)

Applies a custom effect to the current pipeline

Exposure(Single)

Applies an exposure effect on the current pipeline

Exposure(Single, EffectAnimation<Single>)

Applies an exposure effect on the current pipeline

Exposure(Single, EffectSetter<Single>)

Applies an exposure effect on the current pipeline

Exposure(Single, String)

Applies an exposure effect on the current pipeline

FromBackdrop()

Starts a new PipelineBuilder pipeline from the Windows.UI.Composition.CompositionBrush returned by Windows.UI.Composition.Compositor.CreateBackdropBrush

FromBackdropAcrylic(Color, EffectAnimation<Color>, Single, EffectAnimation<Single>, Single, EffectAnimation<Single>, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the in-app backdrop acrylic effect

FromBackdropAcrylic(Color, EffectSetter<Color>, Single, EffectSetter<Single>, Single, EffectSetter<Single>, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the in-app backdrop acrylic effect

FromBackdropAcrylic(Color, Single, Single, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the in-app backdrop acrylic effect

FromBrush(CompositionBrush)

Starts a new PipelineBuilder pipeline from the input Windows.UI.Composition.CompositionBrush instance

FromBrush(Func<CompositionBrush>)

Starts a new PipelineBuilder pipeline from the input Windows.UI.Composition.CompositionBrush instance

FromBrush(Func<Task<CompositionBrush>>)

Starts a new PipelineBuilder pipeline from the input Windows.UI.Composition.CompositionBrush instance

FromColor(Color)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromColor(Color, EffectAnimation<Color>)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromColor(Color, EffectSetter<Color>)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromEffect(Func<IGraphicsEffectSource>)

Starts a new PipelineBuilder pipeline from the input Windows.Graphics.Effects.IGraphicsEffectSource instance

FromEffect(Func<Task<IGraphicsEffectSource>>)

Starts a new PipelineBuilder pipeline from the input Windows.Graphics.Effects.IGraphicsEffectSource instance

FromEffect(IGraphicsEffectSource)

Starts a new PipelineBuilder pipeline from the input Windows.Graphics.Effects.IGraphicsEffectSource instance

FromHdrColor(Vector4)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromHdrColor(Vector4, EffectAnimation<Vector4>)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromHdrColor(Vector4, EffectSetter<Vector4>)

Starts a new PipelineBuilder pipeline from a solid Windows.UI.Composition.CompositionBrush with the specified color

FromHostBackdrop()

Starts a new PipelineBuilder pipeline from the Windows.UI.Composition.CompositionBrush returned by Windows.UI.Composition.Compositor.CreateHostBackdropBrush

FromHostBackdropAcrylic(Color, EffectAnimation<Color>, Single, EffectAnimation<Single>, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the host backdrop acrylic effect

FromHostBackdropAcrylic(Color, EffectSetter<Color>, Single, EffectSetter<Single>, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the host backdrop acrylic effect

FromHostBackdropAcrylic(Color, Single, Uri, CacheMode)

Returns a new PipelineBuilder instance that implements the host backdrop acrylic effect

FromImage(String, DpiMode, CacheMode)

Starts a new PipelineBuilder pipeline from a Win2D image

FromImage(Uri, DpiMode, CacheMode)

Starts a new PipelineBuilder pipeline from a Win2D image

FromTiles(String, DpiMode, CacheMode)

Starts a new PipelineBuilder pipeline from a Win2D image tiled to cover the available space

FromTiles(Uri, DpiMode, CacheMode)

Starts a new PipelineBuilder pipeline from a Win2D image tiled to cover the available space

FromUIElement(UIElement)

Starts a new PipelineBuilder pipeline from the Windows.UI.Composition.CompositionBrush returned by Windows.UI.Composition.Compositor.CreateBackdropBrush on the input Windows.UI.Xaml.UIElement

Grayscale()

Applies a grayscale on the current pipeline

HueRotation(Single)

Applies a hue rotation effect on the current pipeline

HueRotation(Single, EffectAnimation<Single>)

Applies a hue rotation effect on the current pipeline

HueRotation(Single, EffectSetter<Single>)

Applies a hue rotation effect on the current pipeline

HueRotation(Single, String)

Applies a hue rotation effect on the current pipeline

Invert()

Applies an invert effect on the current pipeline

LuminanceToAlpha()

Applies a luminance to alpha effect on the current pipeline

Merge(Func<IGraphicsEffectSource,IGraphicsEffectSource,IGraphicsEffectSource>, PipelineBuilder, IEnumerable<String>, IEnumerable<BrushProvider>)

Blends two pipelines using the provided Func<T1,T2,TResult> to do so

Merge(Func<IGraphicsEffectSource,IGraphicsEffectSource,Task<IGraphicsEffectSource>>, PipelineBuilder, IEnumerable<String>, IEnumerable<BrushProvider>)

Blends two pipelines using the provided asynchronous Func<T1,T2,TResult> to do so

Opacity(Single)

Adds a new Microsoft.Graphics.Canvas.Effects.OpacityEffect to the current pipeline

Opacity(Single, EffectAnimation<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.OpacityEffect to the current pipeline

Opacity(Single, EffectSetter<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.OpacityEffect to the current pipeline

Opacity(Single, String)

Adds a new Microsoft.Graphics.Canvas.Effects.OpacityEffect to the current pipeline

Saturation(Single)

Adds a new Microsoft.Graphics.Canvas.Effects.SaturationEffect to the current pipeline

Saturation(Single, EffectAnimation<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.SaturationEffect to the current pipeline

Saturation(Single, EffectSetter<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.SaturationEffect to the current pipeline

Saturation(Single, String)

Adds a new Microsoft.Graphics.Canvas.Effects.SaturationEffect to the current pipeline

Sepia(Single)

Adds a new Microsoft.Graphics.Canvas.Effects.SepiaEffect to the current pipeline

Sepia(Single, EffectAnimation<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.SepiaEffect to the current pipeline

Sepia(Single, EffectSetter<Single>)

Adds a new Microsoft.Graphics.Canvas.Effects.SepiaEffect to the current pipeline

Sepia(Single, String)

Adds a new Microsoft.Graphics.Canvas.Effects.SepiaEffect to the current pipeline

Shade(Color, EffectAnimation<Color>, Single, EffectAnimation<Single>)

Applies a shade effect on the current pipeline

Shade(Color, EffectSetter<Color>, Single, EffectSetter<Single>)

Applies a shade effect on the current pipeline

Shade(Color, Single)

Applies a shade effect on the current pipeline

TemperatureAndTint(Single, EffectAnimation<Single>, Single, EffectAnimation<Single>)

Applies a temperature and tint effect on the current pipeline

TemperatureAndTint(Single, EffectSetter<Single>, Single, EffectSetter<Single>)

Applies a temperature and tint effect on the current pipeline

TemperatureAndTint(Single, Single)

Applies a temperature and tint effect on the current pipeline

Tint(Color)

Applies a tint effect on the current pipeline

Tint(Color, EffectAnimation<Color>)

Applies a tint effect on the current pipeline

Tint(Color, EffectSetter<Color>)

Applies a tint effect on the current pipeline

Tint(Color, String)

Applies a tint effect on the current pipeline

Applies to