HdrToneMapEffect Class

[Win10_17763] [NoComposition] This effect adjusts the dynamic range of an image to better suit its content to the capability of the output display.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsHdrToneMapEffect

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

Syntax

Copy

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

The HdrToneMapEffect type exposes the following members.

Constructors

	Name	Description
	HdrToneMapEffect	[Win10_17763] Initializes a new instance of the HdrToneMapEffect class.

Top

Properties

	Name	Description
	BufferPrecision	[Win10_17763] Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	[Win10_17763] Enables caching the output from drawing this effect.
	DisplayMode	[Win10_17763] When set to Hdr, the tone mapping curve is adjusted to better fit the fit the behavior of common HDR displays. Default value Sdr.
	InputMaxLuminance	[Win10_17763] The maximum light level (or MaxCLL) of the image, in nits. Default value 4000.
	IsSupported	Checks whether HdrToneMapEffect is supported on the current operating system version.
	Name	[Win10_17763] Attaches a user-defined name string to the effect.
	OutputMaxLuminance	[Win10_17763] The MaxCLL supported by the output target, in nits - typically set to the MaxCLL of the display. Default value 300.
	Source	[Win10_17763] Gets or sets the input source for the effect.

Top

Methods

	Name	Description
	Dispose	[Win10_17763] Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	[Win10_17763] Retrieves the bounds of this HdrToneMapEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	[Win10_17763] Retrieves the bounds of this HdrToneMapEffect.
	GetInvalidRectangles	[Win10_17763] Queries what regions of the effect output have changed since it was last drawn.
	GetRequiredSourceRectangle	[Win10_17763] Queries what part of an effect source image is needed to draw an output region.
	GetRequiredSourceRectangles	[Win10_17763] Queries what parts of the effect source images are needed to draw an output region.
	InvalidateSourceRectangle	[Win10_17763] Notifies the effect that one of its source images has changed.

Top

Remarks

This API is only available when running on Windows 10 build 17763 (October 2018) or greater.

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D HDR tone map effect.

Reference

Microsoft.Graphics.Canvas.Effects Namespace