TFred

TFred runs on the main browser thread and handles rendering, input and the UI context

Index

Constructors

• constructor

Properties

• audio
• canvas
• events
• stats

Methods

• destroy
• toggleFullscreen

Constructors

constructor

• new TFred(engineWorker: Worker, container: HTMLElement, fullscreenContainer: HTMLElement, updateEngineContext: (ctx: TEngineContextData) => void, updateGameContext: (ctx: TGameContextData) => void, setErrorMessage: (message: string) => void, setScaling: (scaling: number) => void, setRenderingSize: (size: { height: number; width: number }) => void, config?: TFredConfig): default

• Parameters

  • engineWorker: Worker

  • container: HTMLElement

  • fullscreenContainer: HTMLElement

  • updateEngineContext: (ctx: TEngineContextData) => void

  • updateGameContext: (ctx: TGameContextData) => void

  • setErrorMessage: (message: string) => void

  • setScaling: (scaling: number) => void

  • setRenderingSize: (size: { height: number; width: number }) => void

  • optionalconfig: TFredConfig

  Returns default

Properties

publicaudio

audio: default = ...

publicoptionalcanvas

canvas?: HTMLCanvasElement

publicevents

events: default

publicstats

stats: TFredStats = ...

Methods

publicdestroy

• destroy(): void

• Trigger cleanup across the whole engine

  ---

  Returns void

publictoggleFullscreen

• toggleFullscreen(): void

• Returns void