RendererConfig

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

Configuration for the renderer plugin.

Properties

backgroundColor?

optional backgroundColor?: number

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

Background color as a hex number.

---

canvas?

optional canvas?: HTMLCanvasElement

Defined in: packages/renderer/src/types.ts:47

Existing canvas element to use.

---

container?

optional container?: HTMLElement

Defined in: packages/renderer/src/types.ts:49

Container element — canvas will be auto-appended here.

---

defaultTextStyle?

optional defaultTextStyle?: TextStyleOptions

Defined in: packages/renderer/src/types.ts:83

Engine-level default text style, applied as the base under every TextComponent / UIText style (per-text values win). Lets you set an app-wide font / fill / resolution without importing pixi to touch TextStyle.defaultTextStyle. @yagejs/ui’s UIPlugin({ defaultTextStyle }) can layer a UI-only override on top.

---

fit?

optional fit?: RendererFitOptions

Defined in: packages/renderer/src/types.ts:60

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: packages/renderer/src/types.ts:39

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

---

pixelArtPreset?

optional pixelArtPreset?: boolean

Defined in: packages/renderer/src/types.ts:75

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.

---

pixi?

optional pixi?: Record<string, unknown>

Defined in: packages/renderer/src/types.ts:53

Additional PixiJS Application options.

---

resolution?

optional resolution?: number

Defined in: packages/renderer/src/types.ts:51

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

---

virtualHeight?

optional virtualHeight?: number

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

Game coordinate height (default: height).

---

virtualWidth?

optional virtualWidth?: number

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

Game coordinate width (default: width).

---

width

width: number

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

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