Click or drag to resize
StraightenEffect Class
[Win10] [NoComposition] Rotates and optionally scales an image.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsStraightenEffect

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

The StraightenEffect type exposes the following members.

Constructors
  NameDescription
Public methodStraightenEffect
Initializes a new instance of the StraightenEffect class.
Top
Properties
  NameDescription
Public propertyAngle
Specifies how much the image should be rotated. Units are specified in radians. Default value 0, range -pi/4 to pi/4.
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 propertyInterpolationMode
Gets or sets the interpolation mode.
Public propertyMaintainSize
Specifies whether the image will be scaled such that the result fits within the original rectangle without any invalid regions, no matter how it is rotated. Default value false.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for Straighten effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this StraightenEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this StraightenEffect.
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

This API is available on Windows 10 (Universal Windows Platform) only. It is not supported on Windows 8.1 or Phone 8.1.

Supported by Win2D but not Windows.UI.Composition.

This effect is useful for correcting photos that were taken at an angle so their horizon is not quite horizontal.

This Windows Runtime type corresponds to the D2D Straighten effect.

See Also