VignetteEffect Class

[NoComposition] Fades out the edges of an image.

Inheritance Hierarchy

System.Object
Microsoft.Graphics.Canvas.Effects.VignetteEffect

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

Syntax

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

The VignetteEffect type exposes the following members.

Constructors

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

Properties

	Name	Description
	Amount	Specifies the size of the vignette region as a percentage of the full image.
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.
	Color	Specifies the color to fade toward. Default value black.
	ColorHdr	Specifies the high-dynamic-range color to fade toward. Default value black.
	Curve	Specifies how quickly the vignette color bleeds in over the region being faded.
	Name	Attaches a user-defined name string to the effect.
	Source	Gets or sets the input source for Vignette effect.

Methods

	Name	Description
	Dispose	Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	Retrieves the bounds of this VignetteEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	Retrieves the bounds of this VignetteEffect.
	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

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D Vignette effect.