Interface: RendererOptions

Defined in: core/Renderer.ts:6

Options for configuring the Renderer.

Properties

alpha?

optional alpha: boolean

Defined in: core/Renderer.ts:20

Enable alpha channel. Defaults to false.

---

antialias?

optional antialias: boolean

Defined in: core/Renderer.ts:14

Enable antialiasing. Defaults to true.

---

backgroundColor?

optional backgroundColor: string

Defined in: core/Renderer.ts:12

Background color as CSS color string. Defaults to '#000000'.

---

backgroundOpacity?

optional backgroundOpacity: number

Defined in: core/Renderer.ts:22

Background opacity (0 = fully transparent, 1 = fully opaque). Defaults to 1. When < 1, alpha channel is enabled automatically. Not supported when exporting to video or GIF formats.

---

canvas?

optional canvas: HTMLCanvasElement

Defined in: core/Renderer.ts:26

Existing canvas element to reuse. If not provided, a new canvas is created.

---

height?

optional height: number

Defined in: core/Renderer.ts:10

Canvas height in pixels. Defaults to container height.

---

pixelRatio?

optional pixelRatio: number

Defined in: core/Renderer.ts:16

Device pixel ratio. Defaults to window.devicePixelRatio (capped at 2x for performance).

---

powerPreference?

optional powerPreference: "default" | "high-performance" | "low-power"

Defined in: core/Renderer.ts:18

GPU power preference. Defaults to 'high-performance'.

---

preserveDrawingBuffer?

optional preserveDrawingBuffer: boolean

Defined in: core/Renderer.ts:24

Preserve drawing buffer for export. Defaults to true for video/image export support.

---

width?

optional width: number

Defined in: core/Renderer.ts:8

Canvas width in pixels. Defaults to container width.