Type Alias: CoreOutputOptions

CoreOutputOptions = object

Defined in: packages/core/src/generated/output.ts:18

Encoder parameters. Mirrors RenderOptions.output on the TypeScript side.

Properties

background?

optional background?: [number, number, number]

Defined in: packages/core/src/generated/output.ts:38

Opaque colour alpha is flattened onto for formats without alpha (JPEG).

---

chromaSubsampling?

optional chromaSubsampling?: ChromaSubsampling

Defined in: packages/core/src/generated/output.ts:30

JPEG only.

---

embed?

optional embed?: string

Defined in: packages/core/src/generated/output.ts:43

UTF-8 text stored in the container's metadata (PNG iTXt, JPEG XMP, WebP XMP). Sealpixel stores the canonical edit log here. Pixels are unaffected.

---

format

format: CoreFormat

Defined in: packages/core/src/generated/output.ts:18

---

lossless?

optional lossless?: boolean

Defined in: packages/core/src/generated/output.ts:34

WebP only. V1 always encodes lossless; false is accepted and treated as lossless.

---

progressive?

optional progressive?: boolean

Defined in: packages/core/src/generated/output.ts:26

JPEG only.

---

quality?

optional quality?: number

Defined in: packages/core/src/generated/output.ts:22

0.0..=1.0, lossy formats only. Ignored by PNG and lossless WebP.