RendererConfig

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

Configuration for the renderer plugin.

Properties

backgroundColor?

optional backgroundColor?: number

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

Background color as a hex number.

canvas?

optional canvas?: HTMLCanvasElement

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

Existing canvas element to use.

container?

optional container?: HTMLElement

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

Container element — canvas will be auto-appended here.

fit?

optional fit?: RendererFitOptions

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

Responsive fit. Defaults to { mode: "letterbox" } against the resolved target (see RendererFitOptions.target), so the canvas is responsive out of the box — override to change mode or pin to a specific host. See RendererFitOptions.

height

height: number

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

Initial canvas height in CSS pixels before responsive fit takes over. Backing-store size is height × resolution.

pixelArtPreset?

optional pixelArtPreset?: boolean

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

One-flag preset for pixel-art games. When true, the plugin:

Sets TextureStyle.defaultOptions.scaleMode = "nearest" so freshly loaded textures sample without bilinear blur.
Enables roundPixels on the Pixi Application so subpixel transforms don’t smear sprite edges.
Applies image-rendering: pixelated (with -webkit-optimize-contrast for Safari) to the canvas element so the browser scales the backing store with nearest-neighbor, not bicubic.

Composes with pixi: explicit pixi.roundPixels: false wins over the preset. Default: false.