Click or drag to resize
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
C#
public sealed class HighlightsAndShadowsEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The HighlightsAndShadowsEffect type exposes the following members.

Constructors
  NameDescription
Public methodHighlightsAndShadowsEffect
Initializes a new instance of the HighlightsAndShadowsEffect class.
Top
Properties
  NameDescription
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 propertyClarity
How much to increase or decrease the mid-tone contrast of the image. Default value 0, range -1 to 1.
Public propertyHighlights
How much to increase or decrease the brighter parts of the image. Default value 0, range -1 to 1.
Public propertyMaskBlurAmount
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.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyShadows
How much to increase or decrease the darker parts of the image. Default value 0, range -1 to 1.
Public propertySource
Gets or sets the input source for HighlightsAndShadows effect.
Public propertySourceIsLinearGamma
Specifies whether the source image uses linear gamma as opposed to the default sRGB.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this HighlightsAndShadowsEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this HighlightsAndShadowsEffect.
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 Windows Runtime type corresponds to the D2D Highlights and shadows effect.

See Also