Click or drag to resize
VignetteEffect Class
[Win10] [NoComposition] Fades out the edges of an image.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsVignetteEffect

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

The VignetteEffect type exposes the following members.

Constructors
  NameDescription
Public methodVignetteEffect
Initializes a new instance of the VignetteEffect class.
Top
Properties
  NameDescription
Public propertyAmount
Specifies the size of the vignette region as a percentage of the full image.
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 propertyColor
Specifies the color to fade toward. Default value black.
Public propertyColorHdr
Specifies the high-dynamic-range color to fade toward. Default value black.
Public propertyCurve
Specifies how quickly the vignette color bleeds in over the region being faded.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for Vignette effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this VignetteEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this VignetteEffect.
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 Vignette effect.

See Also