Interface WebGLRendererEvents

Events for WebGLRenderer.

interface WebGLRendererEvents {
    onError: EventEmitter<
        WebGLRenderer,
        { error: string; ok: false; type: SDKErrorType },
    >;
    onRendererDestroyed: EventEmitter<WebGLRenderer, boolean>;
    onRendererStarted: EventEmitter<WebGLRenderer, void>;
    onRendererStopped: EventEmitter<WebGLRenderer, void>;
    onViewerAttached: EventEmitter<WebGLRenderer, Viewer>;
    onViewerDetached: EventEmitter<WebGLRenderer, Viewer>;
    webglContextLost: EventEmitter<WebGLRenderer, Event>;
    webglContextRestored: EventEmitter<WebGLRenderer, void>;
}

Properties

onError: EventEmitter<
    WebGLRenderer,
    { error: string; ok: false; type: SDKErrorType },
>

Emits an event when an error occurs within the WebGLRenderer.

onRendererDestroyed: EventEmitter<WebGLRenderer, boolean>

Emits an event when the WebGLRenderer itself is destroyed.

onRendererStarted: EventEmitter<WebGLRenderer, void>

Emits an event when the WebGLRenderer is started.

onRendererStopped: EventEmitter<WebGLRenderer, void>

Emits an event when the WebGLRenderer is stopped.

onViewerAttached: EventEmitter<WebGLRenderer, Viewer>

Emits an event when the WebGLRenderer is attached to a Viewer.

onViewerDetached: EventEmitter<WebGLRenderer, Viewer>

Emits an event when the WebGLRenderer is detached from a Viewer.

webglContextLost: EventEmitter<WebGLRenderer, Event>

Emits an event when the WebGL context is lost.

At this point, the WebGLRenderer is not functional until the context is restored.

webglContextRestored: EventEmitter<WebGLRenderer, void>

Emits an event when the WebGL context is restored.

At this point, the WebGLRenderer should have automatically recovered and resumed rendering.