SaturationEffect Class

Alters the saturation of an image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsSaturationEffect

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

Syntax

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

The SaturationEffect type exposes the following members.

Constructors

	Name	Description
	SaturationEffect	Initializes a new instance of the SaturationEffect 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.
	Name	Attaches a user-defined name string to the effect.
	Saturation	Gets or sets the saturation intensity for effect.
	Source	Gets or sets the input source for Saturation effect.

Methods

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

Examples

Suppose, we have a cat image loaded as CanvasBitmap,

SaturationEffect saturationEffect = new SaturationEffect()
{
    Saturation = 0.8,
    Source = cat
};

Use the Draw event to display it:

void myWidget_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    args.DrawingSession.DrawImage(saturationEffect, 42, 42);
}

This Windows Runtime type corresponds to the D2D Saturation effect.