Interface IEffectRenderer
- Namespace
- PaintDotNet.Effects
- Assembly
- PaintDotNet.Effects.Core.dll
The base interface used by an effect host to drive the rendering for an effect. These are created by calling CreateRenderer(Type).
public interface IEffectRenderer : IObjectRef, IIsDisposed, IDisposable, IInternalImpl- Inherited Members
- Extension Methods
Properties
- CancellationToken
Gets the cancellation token for the current rendering task. This should not be cached -- it is recreated whenever rendering is started (e.g. when the token changes).
- Effect
Gets a reference to the effect.
- IsCancelRequested
Gets a flag indicating whether cancellation has been requested.
Methods
- CancelRendering()
Signals to the effect that it should cancel rendering. Threads that are currently rendering will either return early without completing rendering, or will throw an OperationCanceledException. Calling this method does not guarantee that the effect will honor the cancellation request for threads that are currently rendering, but it will prevent new rendering calls from performing any work until the next token change (e.g. with SetToken(EffectConfigToken?)).