Class SaturationEffect.Props

Namespace

PaintDotNet.Direct2D1.Effects

Assembly

PaintDotNet.Windows.Core.dll

public sealed class SaturationEffect.Props : DeviceEffectProperties

Inheritance

object

DeviceEffectProperties

SaturationEffect.Props

Inherited Members

DeviceEffectProperties.Storage

DeviceEffectProperties.ID

DeviceEffectProperties.DisplayName

DeviceEffectProperties.Author

DeviceEffectProperties.Category

DeviceEffectProperties.Description

DeviceEffectProperties.Cached

DeviceEffectProperties.Precision

DeviceEffectProperties.MinInputCount

DeviceEffectProperties.MaxInputCount

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Props()

Properties

ClassID

Implemented by the derived class to specify the effect's class ID (CLSID) when registering and creating the effect and for binding to an IDeviceEffectProperties.
Note that this is different than the ID property accessor, which queries the IDeviceEffectProperties for the actual runtime effect class ID.
Overriding this property is only necessary in advanced scenarios, such as when wrapping an existing effect (e.g. built-in Direct2D effects), or when working with CustomEffects that have their own generic type arguments (e.g. PixelShaderEffect).

Input

Saturation

The saturation of the image. You can set the saturation to a value between 0 and 1. If you set it to 1 the output image is fully saturated. If you set it to 0 the output image is monochrome. The saturation value is unitless. The default value is 0.5f.