BrightnessEffect Class

[NoComposition] Alters the brightness of an image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsBrightnessEffect

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

Syntax

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

The BrightnessEffect type exposes the following members.

Constructors

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

Properties

	Name	Description
	BlackPoint	Sets the black point of the brightness transfer curve. This controls the appearance of darker parts of the image. Default value (0,0).
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.
	Name	Attaches a user-defined name string to the effect.
	Source	Gets or sets the input source for Brightness effect.
	WhitePoint	Sets the white point of the brightness transfer curve. This controls the appearance of lighter parts of the image. Default value (1,1).

Methods

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

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D Brightness effect.