ICanvasEffect Interface

Defines common functionality that is shared by all Win2D effects.

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

Syntax

Copy

public interface ICanvasEffect : IGraphicsEffect, 
	IGraphicsEffectSource, ICanvasImage, IDisposable

The ICanvasEffect type exposes the following members.

Properties

	Name	Description
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.

Top

Methods

	Name	Description
	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.

Top

Remarks

Unlike IGraphicsEffect, which is shared between Win2D and Windows.UI.Composition, the functionality defined by ICanvasEffect is only relevant when an effect is used with Win2D.

Reference

Microsoft.Graphics.Canvas.Effects Namespace