| EdgeDetectionEffect Class |
[Win10] [NoComposition]
Filters out the content of an image leaving lines at the edges of contrasting sections.
Inheritance HierarchyNamespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
SyntaxC#
public sealed class EdgeDetectionEffect : ICanvasEffect, IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable
The EdgeDetectionEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EdgeDetectionEffect | Initializes a new instance of the EdgeDetectionEffect class. |
Properties| Name | Description | |
|---|---|---|
 | AlphaMode | Specifies the treatment of alpha. Default value Premultiplied. |
| Amount | Adjusts the sensitivity of the edge detection filter.
Default value 0.5, range 0 to 1. |
| BlurAmount | 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. |
| BufferPrecision | Specifies what precision to use for intermediate buffers when drawing this effect. |
| CacheOutput | Enables caching the output from drawing this effect. |
| Mode | Specifies what type of filter kernel to use for edge detection.
Default value Sobel. |
| Name | Attaches a user-defined name string to the effect. |
| OverlayEdges | If false, the output image is fully opaque.
If true, input opacity is preserved.
Default value false. |
| Source | Gets or sets the input source for EdgeDetection effect. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the effect. |
| GetBounds(ICanvasResourceCreator) | Retrieves the bounds of this EdgeDetectionEffect. |
| GetBounds(ICanvasResourceCreator, Matrix3x2) | Retrieves the bounds of this EdgeDetectionEffect. |
| 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. |
RemarksThis 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