Click or drag to resize
AtlasEffect Class
[NoComposition] Outputs a specified region from an atlas bitmap.
Inheritance Hierarchy

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version:
public sealed class AtlasEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The AtlasEffect type exposes the following members.

Public methodAtlasEffect
Initializes a new instance of the AtlasEffect class.
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 propertyName
Attaches a user-defined name string to the effect.
Public propertyPaddingRectangle
The padding rectangle specifies how much padding was included when creating the atlas bitmap. This should only be larger than SourceRectangle if the pixels between the two rectangles are transparent black. This may result in Direct2D executing the graph more efficiently.
Public propertySource
Gets or sets the input source for Atlas effect.
Public propertySourceRectangle
Selected region of the source image.
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this AtlasEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this AtlasEffect.
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.

Supported by Win2D but not Windows.UI.Composition.

The atlas effect is useful if you want to load a large image made up of many smaller images, such as various frames of a sprite. The effect crops the input to the given SourceRectangle, and then translates the origin of the result to (0,0).

To crop without translating, use CropEffect.

This Windows Runtime type corresponds to the D2D Atlas effect.

See Also