Skip to content

Interface: Renderer ​

Defined in: packages/core/src/renderer.ts:16

What the session talks to. Implemented by InlineRenderer (same thread) and WorkerRenderer (message protocol to a worker running startSealpixelWorker).

Methods ​

dispose() ​

dispose(): void

Defined in: packages/core/src/renderer.ts:31

Returns ​

void


export() ​

export(req): Promise<ExportResult>

Defined in: packages/core/src/renderer.ts:22

Parameters ​

req ​

ExportRequest

Returns ​

Promise<ExportResult>


geometry() ​

geometry(req): Promise<Geometry>

Defined in: packages/core/src/renderer.ts:23

Parameters ​

req ​
log ​

EditLog

target ​

"workingCopy" | "full"

upTo? ​

number

Returns ​

Promise<Geometry>


init() ​

init(): Promise<{ coreVersion: string; plugins: Record<string, number>; }>

Defined in: packages/core/src/renderer.ts:17

Returns ​

Promise<{ coreVersion: string; plugins: Record<string, number>; }>


load() ​

load(bytes, id, options?): Promise<LoadedSource>

Defined in: packages/core/src/renderer.ts:18

Parameters ​

bytes ​

Uint8Array

id ​

string

options? ​

RendererLoadOptions

Returns ​

Promise<LoadedSource>


loadWorkingCopy() ​

loadWorkingCopy(workingCopy, descriptor): Promise<LoadedSource>

Defined in: packages/core/src/renderer.ts:19

Parameters ​

workingCopy ​

RgbaBuffer

descriptor ​

SourceDescriptor

Returns ​

Promise<LoadedSource>


loadWorkingCopyEncoded() ​

loadWorkingCopyEncoded(bytes, descriptor): Promise<LoadedSource>

Defined in: packages/core/src/renderer.ts:20

Parameters ​

bytes ​

Uint8Array

descriptor ​

SourceDescriptor

Returns ​

Promise<LoadedSource>


putAsset() ​

putAsset(id, bytes): Promise<void>

Defined in: packages/core/src/renderer.ts:30

Stores a verified asset for kernels that reference it by id.

Parameters ​

id ​

string

bytes ​

Uint8Array

Returns ​

Promise<void>


render() ​

render(req): Promise<RgbaBuffer>

Defined in: packages/core/src/renderer.ts:21

Parameters ​

req ​

RenderRequest

Returns ​

Promise<RgbaBuffer>


unload() ​

unload(): Promise<void>

Defined in: packages/core/src/renderer.ts:28

Returns ​

Promise<void>