Class VignetteEffect.Props

Namespace

PaintDotNet.Direct2D1.Effects

Assembly

PaintDotNet.Windows.Core.dll

public sealed class VignetteEffect.Props : DeviceEffectProperties

Inheritance

object

DeviceEffectProperties

VignetteEffect.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).

Color

The color to fade the image's edges to. The default color is black.

Input

Strength

A float value that specifies how much the vignette color bleeds in for a given transition size.
The allowed range is 0.0 to 1.0. The default value is 0.5.

TransitionSize

A float value that specifies the size of the vignette region as a percentage of the full image region.
A size of 0 means the unfaded region is the entire image, while a size of 1 means the faded region is the entire source image.
The allowed range is 0.0 to 1.0. The default value is 0.1.