Interface RendererEvents<TRenderer>

Renderer lifecycle and diagnostic events shared by renderer backends.

Backend-specific renderers may expose additional aliases or events, but higher-level viewer, Studio, and picking code should depend on this surface.

interface RendererEvents<TRenderer = unknown> {
    onContextLost: EventEmitter<TRenderer, Event>;
    onContextRestored: EventEmitter<TRenderer, void>;
    onError: EventEmitter<TRenderer, RendererError>;
    onRendererDestroyed: EventEmitter<TRenderer, boolean>;
    onRendererStarted: EventEmitter<TRenderer, void>;
    onRendererStopped: EventEmitter<TRenderer, void>;
    onViewerAttached: EventEmitter<TRenderer, Viewer>;
    onViewerDetached: EventEmitter<TRenderer, Viewer>;
    onViewRendered: EventEmitter<TRenderer, View>;
}

Type Parameters

  • TRenderer = unknown

    Concrete renderer implementation that emits the events.

Hierarchy (View Summary)

Properties

onContextLost onContextRestored onError onRendererDestroyed onRendererStarted onRendererStopped onViewerAttached onViewerDetached onViewRendered

Properties

ReadonlyonContextLost

onContextLost: EventEmitter<TRenderer, Event>

Emits when the renderer's graphics device or context becomes unavailable.

ReadonlyonContextRestored

onContextRestored: EventEmitter<TRenderer, void>

Emits when the renderer has recovered from a context/device loss.

ReadonlyonError

onError: EventEmitter<TRenderer, RendererError>

Emits renderer errors through the SDK result shape.

ReadonlyonRendererDestroyed

onRendererDestroyed: EventEmitter<TRenderer, boolean>

Emits when the renderer is destroyed.

ReadonlyonRendererStarted

onRendererStarted: EventEmitter<TRenderer, void>

Emits when rendering starts.

ReadonlyonRendererStopped

onRendererStopped: EventEmitter<TRenderer, void>

Emits when rendering stops.

ReadonlyonViewerAttached

onViewerAttached: EventEmitter<TRenderer, Viewer>

Emits after a Viewer has been attached to the renderer.

ReadonlyonViewerDetached

onViewerDetached: EventEmitter<TRenderer, Viewer>

Emits after the currently attached Viewer has been detached.

ReadonlyonViewRendered

onViewRendered: EventEmitter<TRenderer, View>

Emits after the renderer has rendered a frame for a View.

Settings

Member Visibility

On This Page

Properties