Skip to content

Interface: Renderer

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

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:25

Returns

void


export()

export(req): Promise<ExportResult>

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

Parameters

req

ExportRequest

Returns

Promise<ExportResult>


geometry()

geometry(req): Promise<Geometry>

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

Parameters

req
log

EditLog

target

"proxy" | "full"

upTo?

number

Returns

Promise<Geometry>


init()

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

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

Returns

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


load()

load(bytes, id): Promise<LoadedSource>

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

Parameters

bytes

Uint8Array

id

string

Returns

Promise<LoadedSource>


loadProxy()

loadProxy(proxy, descriptor): Promise<LoadedSource>

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

Parameters

proxy

RgbaBuffer

descriptor

SourceDescriptor

Returns

Promise<LoadedSource>


loadProxyEncoded()

loadProxyEncoded(bytes, descriptor): Promise<LoadedSource>

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

Parameters

bytes

Uint8Array

descriptor

SourceDescriptor

Returns

Promise<LoadedSource>


putAsset()

putAsset(id, bytes): Promise<void>

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

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:15

Parameters

req

RenderRequest

Returns

Promise<RgbaBuffer>


unload()

unload(): Promise<void>

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

Returns

Promise<void>