Click or drag to resize
EdgeDetectionEffect Class
[Win10] [NoComposition] Filters out the content of an image leaving lines at the edges of contrasting sections.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsEdgeDetectionEffect

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntax
C#
public sealed class EdgeDetectionEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The EdgeDetectionEffect type exposes the following members.

Constructors
  NameDescription
Public methodEdgeDetectionEffect
Initializes a new instance of the EdgeDetectionEffect class.
Top
Properties
  NameDescription
Public propertyAlphaMode
Specifies the treatment of alpha. Default value Premultiplied.
Public propertyAmount
Adjusts the sensitivity of the edge detection filter. Default value 0.5, range 0 to 1.
Public propertyBlurAmount
Specifies the amount of blur to apply before edge detection. Blur is used to remove high frequencies and reduce phantom edges. Default value 0, range 0 to 10.
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 propertyMode
Specifies what type of filter kernel to use for edge detection. Default value Sobel.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyOverlayEdges
If false, the output image is fully opaque. If true, input opacity is preserved. Default value false.
Public propertySource
Gets or sets the input source for EdgeDetection effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this EdgeDetectionEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this EdgeDetectionEffect.
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

This API is available on Windows 10 (Universal Windows Platform) only. It is not supported on Windows 8.1 or Phone 8.1.

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D Edge detection effect.

See Also