GaussianBlurEffect Class

Creates a blur effect based on the Gaussian function over the entire input image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsGaussianBlurEffect

Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0

Syntax

public sealed class GaussianBlurEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The GaussianBlurEffect type exposes the following members.

Constructors

	Name	Description
	GaussianBlurEffect	Initializes a new instance of the GaussianBlurEffect class.

Properties

	Name	Description
	BlurAmount	Gets or sets the amount of blur to be applied to the image.
	BorderMode	Gets and sets border mode for edge pixels.
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.
	Name	Attaches a user-defined name string to the effect.
	Optimization	Level of performance optimization.
	Source	Gets or sets the input source for Gaussian blur effect.

Methods

	Name	Description
	Dispose	Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	Retrieves the bounds of this GaussianBlurEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	Retrieves the bounds of this GaussianBlurEffect.
	GetInvalidRectangles	Queries what regions of the effect output have changed since it was last drawn.
	GetRequiredSourceRectangle	Queries what part of an effect source image is needed to draw an output region.
	GetRequiredSourceRectangles	Queries what parts of the effect source images are needed to draw an output region.
	InvalidateSourceRectangle	Notifies the effect that one of its source images has changed.

Remarks

Examples

Suppose, we have a cat image loaded as CanvasBitmap,

GaussianBlurEffect blurEffect = new GaussianBlurEffect()
{
    Source = cat,
    BlurAmount = 2.0f
};

Use the Draw event to display it:

void myWidget_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    args.DrawingSession.DrawImage(blurEffect, 42, 42);
}

This Windows Runtime type corresponds to the D2D Gaussian blur effect.