Class Effect<TToken>

Namespace

PaintDotNet.Effects

Assembly

PaintDotNet.Effects.Core.dll

The base class for "classic" effects with a strongly-typed EffectConfigToken.

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

public abstract class Effect<TToken> : Effect, ISerializable, IEffect<TToken>, IEffect, IObjectRef, IIsDisposed, IDisposable where TToken : EffectConfigToken

Type Parameters

TToken

Inheritance

object

RefTrackedObject

ClassicEffectBase

Effect

Effect<TToken>

Implements

ISerializable

IEffect<TToken>

IEffect

IObjectRef

IIsDisposed

IDisposable

Derived

PropertyBasedEffect

Inherited Members

Effect.SignalCancelRequest()

Effect.SetRenderInfo(EffectConfigToken, RenderArgs, RenderArgs)

Effect.Render(EffectConfigToken, RenderArgs, RenderArgs, Rectangle[])

Effect.CreateConfigDialog()

Effect.Services

Effect.EnvironmentParameters

Effect.Image

Effect.IsCancelRequested

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)

EffectsObjectRefExtensions.CreateRefT<TToken>(IEffect<TToken>)

Constructors

Effect(string, IBitmapSource, string?, EffectOptions)

Effect(string, Image, string?, EffectOptions)

Effect(string, string?, EffectOptions)

Properties

DstArgs

SrcArgs

Token

Methods

OnRender(Rectangle[], int, int)

OnSetRenderInfo(EffectConfigToken?, RenderArgs, RenderArgs)

OnSetRenderInfo(TToken?, RenderArgs, RenderArgs)

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.

Render(Rectangle[], int, int)