Skip to content

@kitware/vtk-wasm / @kitware/vtk-wasm / VtkWasmRuntime

Class: VtkWasmRuntime

Defined in: runtime.js:177

A loaded VTK.wasm WebAssembly module. Acts as the single factory for sessions.

Constructors

Constructor

ts
new VtkWasmRuntime(module, key): VtkWasmRuntime;

Defined in: runtime.js:182

Parameters

ParameterType
moduleany
keyany

Returns

VtkWasmRuntime

Accessors

id

Get Signature

ts
get id(): any;

Defined in: runtime.js:189

The unique identifier for the wasm module that this runtime was created from. Looks like: url::wasmBaseName::config.rendering::config.exec

Returns

any


module

Get Signature

ts
get module(): any;

Defined in: runtime.js:194

The underlying Emscripten module. Escape hatch; prefer the session API.

Returns

any

Methods

[dispose]()

ts
dispose: void;

Defined in: runtime.js:237

Returns

void


createRemoteSession()

ts
createRemoteSession(): RemoteSession;

Defined in: runtime.js:216

Create a server-driven remote session.

Returns

RemoteSession


createStandaloneSession()

ts
createStandaloneSession(): StandaloneSession;

Defined in: runtime.js:207

Create an in-browser standalone session.

Returns

StandaloneSession


dispose()

ts
dispose(): void;

Defined in: runtime.js:226

Drop this runtime from the shared cache and release the module reference. Note: Emscripten cannot reclaim a runtime's heap before page reload; disposing individual sessions is what actually frees C++ memory.

Returns

void


isAsync()

ts
isAsync(): boolean;

Defined in: runtime.js:199

Returns

boolean

whether this runtime executes methods asynchronously (JSPI).