Click or drag to resize
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
C#
public sealed class GaussianBlurEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The GaussianBlurEffect type exposes the following members.

Constructors
  NameDescription
Public methodGaussianBlurEffect
Initializes a new instance of the GaussianBlurEffect class.
Top
Properties
  NameDescription
Public propertyBlurAmount
Gets or sets the amount of blur to be applied to the image.
Public propertyBorderMode
Gets and sets border mode for edge pixels.
Public propertyBufferPrecision
Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
Enables caching the output from drawing this effect.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyOptimization
Level of performance optimization.
Public propertySource
Gets or sets the input source for Gaussian blur effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this GaussianBlurEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this GaussianBlurEffect.
Public methodGetInvalidRectangles
Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
Notifies the effect that one of its source images has changed.
Top
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.

See Also