HighlightsAndShadowsEffect Class

[Win10] [NoComposition] Adjusts the highlights and shadows of an image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsHighlightsAndShadowsEffect

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

Syntax

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

The HighlightsAndShadowsEffect type exposes the following members.

Constructors

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

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.
	Clarity	How much to increase or decrease the mid-tone contrast of the image. Default value 0, range -1 to 1.
	Highlights	How much to increase or decrease the brighter parts of the image. Default value 0, range -1 to 1.
	MaskBlurAmount	Controls the size of the region used around a pixel to classify it as highlight or shadow. Lower values result in more localized adjustments. Default value 1.25, range 0 to 10.
	Name	Attaches a user-defined name string to the effect.
	Shadows	How much to increase or decrease the darker parts of the image. Default value 0, range -1 to 1.
	Source	Gets or sets the input source for HighlightsAndShadows effect.
	SourceIsLinearGamma	Specifies whether the source image uses linear gamma as opposed to the default sRGB.

Methods

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

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 Windows Runtime type corresponds to the D2D Highlights and shadows effect.