Interface: RenderOptions

Defined in: packages/core/src/types.ts:92

Properties

assets?

optional assets?: AssetResolver

Defined in: packages/core/src/types.ts:107

Supplies fonts and images referenced by the log.

---

embedEditLog?

optional embedEditLog?: boolean

Defined in: packages/core/src/types.ts:113

Store canonicalJson({ log, index }) in the file's metadata so it can be reopened with readEmbeddedState. Off by default: the log may contain text the user does not want to ship.

---

manifest?

optional manifest?: boolean

Defined in: packages/core/src/types.ts:119

Also return a render manifest: the source hash, the edit log, the plan, this renderer's identity and the hash of the rendered pixels. Off by default, because the pixel hash reads the whole rendered buffer once.

---

mode?

optional mode?: "truth" | "preview"

Defined in: packages/core/src/types.ts:98

truth (default) requires the buffer to have the logical source dimensions. preview accepts a working copy and scales lengths accordingly.

---

output

output: OutputOptions

Defined in: packages/core/src/types.ts:93

---

registry?

optional registry?: Registry

Defined in: packages/core/src/types.ts:105

Plugins that interpret the log's ops. Required when the log has ops.

---

signal?

optional signal?: AbortSignal

Defined in: packages/core/src/types.ts:101

---

sourceHash?

optional sourceHash?: string

Defined in: packages/core/src/types.ts:126

sha256 of the original's bytes, for the manifest, when source is a buffer that was decoded elsewhere. Required then, because the log's source.hash is a claim about bytes this call never sees. Ignored when source is bytes, which are hashed here.

---

upTo?

optional upTo?: number

Defined in: packages/core/src/types.ts:100

Render only ops[0..upTo). Defaults to all ops.

---

wasm?

optional wasm?: SealpixelWasm

Defined in: packages/core/src/types.ts:103

Pre-loaded core. Servers pass this to reuse one instance across requests.