Class: RendererCore

Defined in: packages/core/src/renderer-core.ts:64

Constructors

Constructor

new RendererCore(wasm, options): RendererCore

Defined in: packages/core/src/renderer-core.ts:74

Parameters

wasm

SealpixelWasm

options

RendererCoreOptions

Returns

RendererCore

Properties

registry

readonly registry: Registry

Defined in: packages/core/src/renderer-core.ts:65

---

wasm

readonly wasm: SealpixelWasm

Defined in: packages/core/src/renderer-core.ts:75

Methods

cacheSize()

cacheSize(): number

Defined in: packages/core/src/renderer-core.ts:332

For tests: number of cached stage outputs.

Returns

number

---

export()

export(req): Promise<ExportResult>

Defined in: packages/core/src/renderer-core.ts:181

Parameters

req

ExportRequest

Returns

Promise<ExportResult>

---

geometry()

geometry(log, target, upTo?): Geometry

Defined in: packages/core/src/renderer-core.ts:201

Parameters

log

EditLog

target

"workingCopy" | "full"

upTo?

number

Returns

Geometry

---

hasAsset()

hasAsset(id): boolean

Defined in: packages/core/src/renderer-core.ts:86

Parameters

id

string

Returns

boolean

---

hasSource()

hasSource(): boolean

Defined in: packages/core/src/renderer-core.ts:140

Returns

boolean

---

info()

info(): object

Defined in: packages/core/src/renderer-core.ts:90

Returns

object

coreVersion

coreVersion: string

plugins

plugins: Record<string, number>

---

isResident()

isResident(): boolean

Defined in: packages/core/src/renderer-core.ts:144

Returns

boolean

---

load()

load(bytes, id, loadOptions?): LoadedSource

Defined in: packages/core/src/renderer-core.ts:95

Decodes bytes, derives the descriptor and working copy, and drops the full image when too large.

Parameters

bytes

Uint8Array

id

string

loadOptions?

RendererLoadOptions = {}

Returns

LoadedSource

---

loadWorkingCopy()

loadWorkingCopy(workingCopy, descriptor): LoadedSource

Defined in: packages/core/src/renderer-core.ts:127

Accepts pixels decoded elsewhere, for example by a native decoder. Never resident.

Parameters

workingCopy

RgbaBuffer

descriptor

SourceDescriptor

Returns

LoadedSource

---

loadWorkingCopyEncoded()

loadWorkingCopyEncoded(bytes, descriptor): LoadedSource

Defined in: packages/core/src/renderer-core.ts:122

Decodes an encoded working copy (for example one the host built elsewhere) and uses it as the preview source.

Parameters

bytes

Uint8Array

descriptor

SourceDescriptor

Returns

LoadedSource

---

putAsset()

putAsset(id, bytes): void

Defined in: packages/core/src/renderer-core.ts:82

Parameters

id

string

bytes

Uint8Array

Returns

void

---

render()

render(req): Promise<RgbaBuffer>

Defined in: packages/core/src/renderer-core.ts:157

Renders the log. Preview renders are split per stage and cached by prefix.

Parameters

req

RenderRequest

Returns

Promise<RgbaBuffer>

---

unload()

unload(): void

Defined in: packages/core/src/renderer-core.ts:148

Returns

void