Table of Contents

Class PdnHueSaturationLightnessEffect.Props

Namespace
PaintDotNet.Effects.Gpu
Assembly
PaintDotNet.Effects.Gpu.dll
public sealed class PdnHueSaturationLightnessEffect.Props : CustomEffectProperties
Inheritance
PdnHueSaturationLightnessEffect.Props
Inherited Members

Constructors

Props()

Properties

AlphaMode

Specifies the alpha mode for the input image, for the the output.
The default value is Premultiplied.

HueAngleDelta

Specifies the change to each pixel's hue. Any finite value is acceptable, but the effective range is [-180.0f, +180.0f] due to wrapping.
The default values is 0, which will leave the hue unchanged.

Input
LightnessDelta

Specifies the amount to change each pixel's lightness by. The range for lightness is [0, 1], so the range of this property is [-1.0f, +1.0f]. This corresponds to the UI's range of [-100, +100].
A value of -1 will produce a completely black image, while a value of +1 will produce a completely white image.
Results will be clamped to a valid range.
The default value is 0.
Note that this "lightness" does not operate in exactly the same way as "lightness" in HSL does. It is a simple linear interpolation between black and white.

SaturationFactor

Specifies a value for changing each pixel's saturation. A pixel's saturation ranges from 0 (unsaturated/grey) to 1 (fully saturated).
If the value is set to 1.0, saturation will be unchanged.
If the value is set to 0, the image will be completely desaturated.
For values less than 1.0, the saturation will be multiplied by the value.
For values greater than 1.0, the saturation will be multiplied by 1+((value-1)*3), which effectively amplifies the scaling by 3x.
The range of this value is [0, 2], which corresponds to the UI's range of [0, 200].
The default value is 1.

Methods

CreateImpl()
GetAuthor()
GetCategory()
GetDescription()
GetDisplayName()