Skip to content
InterfaceTypes & Utilities@public

CreateBrowserGameOptions

Options for link.

ts
export interface CreateBrowserGameOptions

Properties

PropertyModifiersTypeDescription
accessibility-booleanNative keyboard and screen-reader controls for supported Flixel UI. Defaults to true.
assets-BrowserGameAssetOptionsDeclarative Pixi asset bundles and resolver configuration.
audioBackend-FlxAudioBackend-
audioControls-boolean | FlxAudioControlsOptionsOptional accessible master volume/mute controls. Disabled by default.
autoPause-booleanPause fixed simulation updates while the page is hidden or unfocused. Defaults to true.
backgroundColor-number-
fpsDisplay-boolean | FlxFpsDisplayOptionsOptional lightweight in-game FPS overlay. Disabled by default.
height-number-
host-HTMLElement-
initialState-FlxStateConstructor-
maxDevicePixelRatio-numberUpper bound for renderer resolution as browser DPR changes. Defaults to 2.
onLoadingSnapshot-(snapshot: FlxLoadingSnapshot) => voidObserve the same snapshots used by DOM and in-game loading screens.
preload-(context: BrowserGamePreloadContext) => Promise<void> | voidCustom preparation that runs while the bootstrap preloader is active.
preloader-false | BrowserGamePreloaderOptionsDefault DOM preloader, custom view configuration, or false to disable it.
renderer-BrowserGameRendererOptionsGPU backend preference and WebGPU-to-WebGL recovery policy.
renderFramerate-numberOptional visual frame-rate cap. By default rendering follows the display.
renderInterpolation-booleanSmooth fixed-step motion between updates without changing game state. Defaults to true.
scaling-FlxBrowserScaleMode | FlxBrowserScaleOptionsCSS-space canvas scaling policy. Defaults to aspect-preserving fit.
showPreloader-boolean-
signal-AbortSignalCancels pending application-level startup and retry waits.
title-string-
updateFramerate-numberFixed simulation rate in updates per second. Defaults to 60.
width-number-
zoom-number-

Released under the MIT License.