Skip to content

RendererConfig

Defined in: renderer/src/types.ts:27

Configuration for the renderer plugin.

optional backgroundColor?: number

Defined in: renderer/src/types.ts:37

Background color as a hex number.


optional canvas?: HTMLCanvasElement

Defined in: renderer/src/types.ts:39

Existing canvas element to use.


optional container?: HTMLElement

Defined in: renderer/src/types.ts:41

Container element — canvas will be auto-appended here.


height: number

Defined in: renderer/src/types.ts:31

Canvas height in physical pixels.


optional pixi?: Record<string, unknown>

Defined in: renderer/src/types.ts:45

Additional PixiJS Application options.


optional resolution?: number

Defined in: renderer/src/types.ts:43

Device pixel ratio. Defaults to window.devicePixelRatio for crisp rendering on HiDPI displays. Set to 1 to disable.


optional virtualHeight?: number

Defined in: renderer/src/types.ts:35

Game coordinate height (default: height).


optional virtualWidth?: number

Defined in: renderer/src/types.ts:33

Game coordinate width (default: width).


width: number

Defined in: renderer/src/types.ts:29

Canvas width in physical pixels.