SaturationEffect Class

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.UI.Media

Assembly:: Microsoft.Toolkit.Uwp.UI.Media.dll

Package:: Microsoft.Toolkit.Uwp.UI.Media v7.0.2

Package:: Microsoft.Toolkit.Uwp.UI.Media v7.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A saturation effect

public sealed class SaturationEffect : Microsoft.Toolkit.Uwp.UI.Media.PipelineEffect

type SaturationEffect = class
    inherit PipelineEffect

Public NotInheritable Class SaturationEffect
Inherits PipelineEffect

Inheritance: Windows.UI.Xaml.DependencyObject

PipelineEffect
SaturationEffect

Remarks

This effect maps to the Win2D Microsoft.Graphics.Canvas.Effects.SaturationEffect effect

Constructors

SaturationEffect()

Properties

Brush	Gets the current Windows.UI.Composition.CompositionBrush instance, if one is in use. (Inherited from PipelineEffect)
IsAnimatable	Gets or sets a value indicating whether the effect can be animated. (Inherited from PipelineEffect)
Value	Gets or sets the saturation amount to apply to the background (defaults to 1, should be in the [0, 1] range).

Methods

AppendToBuilder(PipelineBuilder)	Appends the current effect to the input PipelineBuilder instance.
NotifyCompositionBrushInUse(CompositionBrush)	Notifies that a given Windows.UI.Composition.CompositionBrush is now in use. (Inherited from PipelineEffect)

Applies to