ScaleEffect Class

ScaleEffect Class

[NoComposition] Resizes an image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsScaleEffect

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

Syntax

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

The ScaleEffect type exposes the following members.

Constructors

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

Properties

	Name	Description
	BorderMode	Border mode for edge pixels. Default value Soft.
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.
	CenterPoint	Point to scale around. Default value (0,0).
	InterpolationMode	Interpolation mode. Default value Linear.
	Name	Attaches a user-defined name string to the effect.
	Scale	Image scale factor. Default value (1,1).
	Sharpness	When using high quality cubic interpolation mode, specifies the sharpness level of the scaling filter as a float between 0 and 1.
	Source	Gets or sets the input source for Scale effect.

Methods

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