Table of Contents

Class PreviewContext

Namespace
nadena.dev.ndmf.preview

Provides pipeline-scoped preview services to render filters while a preview pipeline is executing.

public sealed class PreviewContext
Inheritance
PreviewContext
Inherited Members

Constructors

PreviewContext()

Creates a mutable preview context for an externally controlled preview scope.

public PreviewContext()

Properties

Instance

Gets the context active in the current asynchronous task scope.

public static PreviewContext Instance { get; }

Property Value

PreviewContext

Exceptions

InvalidOperationException

Thrown when no preview context is active in the current asynchronous task scope.

ShadowBoneManager

Gets or sets the shadow-bone manager handle available to this context.

public IShadowBoneManagerHandle ShadowBoneManager { get; set; }

Property Value

IShadowBoneManagerHandle

Exceptions

InvalidOperationException

Thrown when the handle has not been configured, or when setting a sealed context.

ArgumentNullException

Thrown when assigning null.

Methods

Activate()

Makes this context current until the returned scope is disposed.

public IDisposable Activate()

Returns

IDisposable

A scope which restores the previously active context when disposed.