Class CustomEffect<TProperties>

Namespace

PaintDotNet.Direct2D1.Effects

Assembly

PaintDotNet.Windows.Core.dll

The base class for implementing a custom effect in Direct2D. The custom effects system in PaintDotNet.Direct2D1 handles many things automatically, such as just-in-time registration and auto-generation of the registration XML.

public abstract class CustomEffect<TProperties> : DeviceEffect<TProperties>, ISerializable, IDeviceEffect, IDeviceImage, IDirect2DResource, IFactoryProperty, IDeviceEffectProperties, IInternalImpl, IObjectRef, IIsDisposed, IDisposable where TProperties : CustomEffectProperties, new()

Type Parameters

TProperties

The properties class. It is recommended to use a sealed, nested class named Props.

Inheritance

object

RefTrackedObject

DeviceEffect

DeviceEffect<TProperties>

CustomEffect<TProperties>

Implements

ISerializable

IDeviceEffect

IDeviceImage

IDirect2DResource

IFactoryProperty

IDeviceEffectProperties

IInternalImpl

IObjectRef

IIsDisposed

IDisposable

Derived

AlphaMaskEffect2

BitmapSourceEffect2

BlendEffect2

BokehBlurEffect

BokehBlurMapEffect

BorderEffect2

ClampEffect

ConvertAlphaEffect

ConvertGammaEffect

CroppedFloodEffect

CrossFadeEffect

CrossFadeMaskEffect

EdgeDetectionEffect

EmptyEffect

FloodEffect2

GammaTransferEffect2

GaussianBlurEffect2

GaussianBlurMapEffect

GrayscaleEffect2

HlslBinaryFunctionEffect

HlslBinaryOperatorEffect

HlslTernaryFunctionEffect

HlslUnaryFunctionEffect

HlslUnaryOperatorEffect

InputSelectorEffect

InputSwizzleEffect

InvertAlphaEffect

InvertEffect2

LinearToSrgbEffect

MakeOpaqueEffect

MixEffect

PassthroughEffect

PixelSwizzleEffect

PosterizeEffect2

PrecisionEffect

PremultiplyEffect2

RandomNoiseEffect

ReplaceChannelEffect

ScenePositionEffect

SepiaEffect2

ShadowEffect2

SrgbToLinearEffect

UnPremultiplyEffect2

PdnAddNoiseEffect

PdnBrightnessContrastEffect

PdnCloudsEffect

PdnDropShadowEffect

PdnEmbossEffect

PdnFragmentEffect

PdnGlowEffect

PdnHueSaturationLightnessEffect

PdnInkSketchEffect

PdnJuliaFractalEffect

PdnMandelbrotFractalEffect

PdnMotionBlurEffect

PdnPencilSketchEffect

PdnPixelateEffect

PdnReliefEffect

PdnSoftenPortraitEffect

PdnVignetteEffect

Inherited Members

DeviceEffect<TProperties>.Properties

DeviceEffect.Dispose(bool)

DeviceEffect.IsInputSet(int)

DeviceEffect.GetInput(int)

DeviceEffect.SetInput(int, IDeviceImage, bool)

DeviceEffect.TryGetSubProperties(int, out IDeviceEffectProperties)

DeviceEffect.TryGetPropertyName(int, out string)

DeviceEffect.TryGetPropertyIndex(string, out int)

DeviceEffect.TryGetPropertyType(int, out DeviceEffectPropertyType)

DeviceEffect.TryGetValueSize(int, out int)

DeviceEffect.GetValue(int, DeviceEffectPropertyType, Span<byte>)

DeviceEffect.GetValueByName(string, DeviceEffectPropertyType, Span<byte>)

DeviceEffect.GetValueRef(int, DeviceEffectPropertyType, Type)

DeviceEffect.GetValueRefByName(string, DeviceEffectPropertyType, Type)

DeviceEffect.GetValueSize(int)

DeviceEffect.SetValue(int, DeviceEffectPropertyType, ReadOnlySpan<byte>)

DeviceEffect.SetValueByName(string, DeviceEffectPropertyType, ReadOnlySpan<byte>)

DeviceEffect.SetValueRef(int, DeviceEffectPropertyType, IObjectRef)

DeviceEffect.SetValueRefByName(string, DeviceEffectPropertyType, IObjectRef)

DeviceEffect.InputCount

DeviceEffect.Factory

DeviceEffect.PropertyCount

RefTrackedObject.Dispose()

RefTrackedObject.TryCreateRef(Type, out IObjectRef)

RefTrackedObject.IsDisposed

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

DeviceEffectExtensions.Initialize<TEffect>(TEffect, Action<TEffect>)

DeviceEffectExtensions.InvalidateInputRectangle(IDeviceEffect, IDeviceContext, int, RectFloat)

DeviceImageExtensions.GetLocalBounds(IDeviceImage, IDeviceContext)

DeviceImageExtensions.GetWorldBounds(IDeviceImage, IDeviceContext)

Constructors

CustomEffect(IDeviceEffectFactory)