Class Effect

Namespace

PaintDotNet.Effects

Assembly

PaintDotNet.Effects.Core.dll

The base class for "classic" effects.

NOTE: It is strongly recommended that you derive from BitmapEffect instead.

public abstract class Effect : ClassicEffectBase, ISerializable, IEffect, IObjectRef, IIsDisposed, IDisposable

Inheritance

object

RefTrackedObject

ClassicEffectBase

Effect

Implements

ISerializable

IEffect

IObjectRef

IIsDisposed

IDisposable

Derived

Effect<TToken>

InternalEffect

Inherited Members

ClassicEffectBase.Dispose(bool)

ClassicEffectBase.OnDispose(bool)

ClassicEffectBase.Category

ClassicEffectBase.Options

ClassicEffectBase.SubMenuName

ClassicEffectBase.Name

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

EffectsObjectRefExtensions.CreateRef(IEffect)

Constructors

Effect(string, IBitmapSource, string?, EffectOptions)

The constructor for the Effect class.

Effect(string, Image, string?, EffectOptions)

The constructor for the Effect class.

Effect(string, string?, EffectOptions)

The constructor for the Effect class.

Properties

EnvironmentParameters

Image

IsCancelRequested

Services

Methods

CreateConfigDialog()

OnSetRenderInfo(EffectConfigToken?, RenderArgs, RenderArgs)

Render(EffectConfigToken?, RenderArgs, RenderArgs, Rectangle[])

Render(EffectConfigToken?, RenderArgs, RenderArgs, Rectangle[], int, int)

Performs the effect's rendering. The source is to be treated as read-only, and only the destination pixels within the given rectangle-of-interest are to be written to. However, in order to compute the destination pixels, any pixels from the source may be utilized.

SetRenderInfo(EffectConfigToken?, RenderArgs, RenderArgs)

SignalCancelRequest()