Click or drag to resize
CropEffect Class
[NoComposition] Crops an image, outputting only a specified region.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsCropEffect

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

The CropEffect type exposes the following members.

Constructors
  NameDescription
Public methodCropEffect
Initializes a new instance of the CropEffect class.
Top
Properties
  NameDescription
Public propertyBorderMode
Border mode for edge pixels. Default value Soft.
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 propertySource
Gets or sets the input source for Crop effect.
Public propertySourceRectangle
Selected region of the source image.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this CropEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this CropEffect.
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

Supported by Win2D but not Windows.UI.Composition.

Note that cropping changes the bounds of the image, but does not move it. If you also want to move the cropped area to the origin, combine this with a 2D translation or use AtlasEffect.

This Windows Runtime type corresponds to the D2D Crop effect.

See Also