Click or drag to resize
WhiteLevelAdjustmentEffect Class
[Win10_17763] [NoComposition] This effect allows the white level of an image to be linearly scaled. This is especially helpful when you convert between display-referred luminance space and scene-referred luminance space, or vice versa.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsWhiteLevelAdjustmentEffect

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 WhiteLevelAdjustmentEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The WhiteLevelAdjustmentEffect type exposes the following members.

Constructors
  NameDescription
Public methodWhiteLevelAdjustmentEffect
[Win10_17763] Initializes a new instance of the WhiteLevelAdjustmentEffect class.
Top
Properties
  NameDescription
Public propertyBufferPrecision
[Win10_17763] Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
[Win10_17763] Enables caching the output from drawing this effect.
Public propertyInputWhiteLevel
[Win10_17763] The white level of the input image, in nits. Default value 80.
Public propertyStatic memberIsSupported
Checks whether WhiteLevelAdjustmentEffect is supported on the current operating system version.
Public propertyName
[Win10_17763] Attaches a user-defined name string to the effect.
Public propertyOutputWhiteLevel
[Win10_17763] The white level of the output image, in nits. Default value 80.
Public propertySource
[Win10_17763] Gets or sets the input source for the effect.
Top
Methods
  NameDescription
Public methodDispose
[Win10_17763] Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
[Win10_17763] Retrieves the bounds of this WhiteLevelAdjustmentEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
[Win10_17763] Retrieves the bounds of this WhiteLevelAdjustmentEffect.
Public methodGetInvalidRectangles
[Win10_17763] Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
[Win10_17763] Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
[Win10_17763] Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
[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 White level adjustment effect.

See Also