Class GaussianBlurEffect.Props
- Namespace
- PaintDotNet.Direct2D1.Effects
- Assembly
- PaintDotNet.Windows.Core.dll
public sealed class GaussianBlurEffect.Props : DeviceEffectProperties- Inheritance
-
GaussianBlurEffect.Props
- Inherited Members
Constructors
Properties
- BorderMode
The mode used to calculate the border of the image.
When set to BorderMode.Soft, the effect pads the image with transparent black pixels as it applies the blur kernel, resulting in a soft edge.
When set to BorderMode.Hard, the effect clamps the output to the size of the input image. When the effect applies the blur kernel, it extends the input image with a mirror-type border transform for samples outside of the input bounds.
The default value is BorderMode.Soft.
- 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).
- Optimization
The optimization mode. The default value is GaussianBlurOptimization.Quality.
- StandardDeviation
The amount of blur to be applied to the image. You can compute the blur radius of the kernel by multiplying the standard deviation by 3. You can compute the standard deviation by dividing the blur radius by 3. The units of both the standard deviation and blur radius are DIPs. A value of zero disables this effect entirely.
You can use the StandardDeviation class to simplify conversion between standard deviation and radius.
The range of this value is [0, 250], which corresponds to a blur radius of [0, 750]. The default value is 3.