Class Display

constructor

• new Display(): Display

  Creates a display wrapper with default resolution and renderer settings.

  Returns Display

renderer

destroy

• destroy(): void

  Destroys the renderer and recreates the DOM canvas element.

  Returns void

  Nothing.

getAntialias

• getAntialias(): AntialiasTypeEnum

  Returns the configured antialiasing mode.

  Returns AntialiasTypeEnum

  The antialias mode.

getBackgroundColor

• getBackgroundColor(): string

  Returns the configured display background color.

  Returns string

  The background color string.

getClipIdByCursorPosition

• getClipIdByCursorPosition(cursorX: number, cursorY: number): null | string

  Returns the top-most clip under the specified cursor position.

  Parameters

  • cursorX: number

    Cursor X coordinate in canvas space.

  • cursorY: number

    Cursor Y coordinate in canvas space.

  Returns null | string

  The matching clip ID, or null if no clip is hit.

getHeight

• getHeight(): number

  Returns the current display height.

  Returns number

  The display height in pixels.

getResolution

• getResolution(): [number, number]

  Returns the current display resolution.

  Returns [number, number]

  The [width, height] tuple in pixels.

getView

• getView(): HTMLCanvasElement

  Returns the renderer canvas element.

  Returns HTMLCanvasElement

  The canvas element, if the renderer is initialized.

getWidth

• getWidth(): number

  Returns the current display width.

  Returns number

  The display width in pixels.

init

• init(options: DisplayOptions): void

  Initializes the PIXI renderer and applies the requested display configuration.

  Parameters

  • options: DisplayOptions

    Display initialization options, including the target canvas element.

  Returns void

  Nothing.

serialize

• serialize(): { backgroundColor: string; height: number; width: number }

  Serializes the current display state.

  Returns { backgroundColor: string; height: number; width: number }

  The serialized display payload.

setBackgroundColor

• setBackgroundColor(color: string): void

  Updates the display background color.

  Parameters

  • color: string

    New CSS color or gradient string.

  Returns void

  Nothing.

setResolution

• setResolution(width: number, height: number): void

  Resizes the display and notifies dependent subsystems.

  Parameters

  • width: number

    New display width, in pixels.

  • height: number

    New display height, in pixels.

  Returns void

  Nothing.

Staticdeserialize

• deserialize(data: object): Display

  Restores a display instance from serialized data while preserving the current canvas and antialias configuration.

  Parameters

  • data: object

    Serialized display payload.

  Returns Display

  The deserialized display instance.