Class GpuImageEffect

Namespace

PaintDotNet.Effects.Gpu

Assembly

PaintDotNet.Effects.Core.dll

The base class for Direct2D GPU effects that are based on Direct2D's imaging/effects system. For effects that want to be based on drawing commands (e.g. DrawBitmap, FillRectangle), GpuDrawingEffect (or PropertyBasedGpuDrawingEffect) is probably the right choice instead of this class.

public abstract class GpuImageEffect : GpuEffect2, ISerializable, IGpuImageEffect, IGpuEffect2, IGpuEffect, IEffect, IObjectRef, IIsDisposed, IDisposable

Inheritance

object

RefTrackedObject

EffectBase

GpuEffect

GpuEffect2

GpuImageEffect

Implements

ISerializable

IGpuImageEffect

IGpuEffect2

IGpuEffect

IEffect

IObjectRef

IIsDisposed

IDisposable

Derived

GpuDrawingEffect

GpuImageEffect<TToken>

Inherited Members

GpuEffect2.Environment

GpuEffect.OnDispose(bool)

GpuEffect.OnSetToken(EffectConfigToken)

GpuEffect.OnSetDeviceContext(IDeviceContext)

EffectBase.Dispose(bool)

EffectBase.OnCreateConfigForm()

EffectBase.Services

EffectBase.IsCancelRequested

EffectBase.CancellationToken

EffectBase.Token

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

GpuObjectRefExtensions.CreateRef(IGpuEffect)

GpuObjectRefExtensions.CreateRef(IGpuEffect2)

GpuObjectRefExtensions.CreateRef(IGpuImageEffect)

EffectsObjectRefExtensions.CreateRef(IEffect)

Constructors

GpuImageEffect(string, IBitmapSource, string?, GpuImageEffectOptions)

GpuImageEffect(string, Image, string?, GpuImageEffectOptions)

GpuImageEffect(string, string?, GpuImageEffectOptions)

Methods

OnCreateOutput(IDeviceContext)

Creates and returns the IDeviceImage that will be used for rendering.

OnDraw(IDeviceContext, RectInt32)

This method is called to render a portion of the output. You may use the clipRect to optimize your drawing calls.

OnInitializeRenderInfo(IGpuEffectRenderInfo)

OnInitializeRenderInfo(IGpuImageEffectRenderInfo)

OnInspectTokenChanges(EffectConfigToken, EffectConfigToken)

OnInvalidateDeviceResources()

This method can be used to Dispose() any resources created from the device context.

OnUpdateOutput(IDeviceContext)