Skip to content
InterfaceDebugger & Diagnostics@public

FlxFpsDisplayOptions

Options for link.

ts
export interface FlxFpsDisplayOptions

Properties

PropertyModifiersTypeDescription
className-stringOptional CSS class names applied to the root element.
container-HTMLElementOverlay host. Defaults to document.body.
mode-'compact' | 'detailed'Compact shows FPS only; detailed also shows frame pacing and update cadence.
placement-'host' | 'viewport'Whether positioning is relative to the host or viewport.
position-FlxFpsDisplayPositionScreen corner. Defaults to top-right.
targetFramerate-numberOptional expected FPS used to color the reading.
theme-FlxFpsDisplayThemeVisual theme overrides exposed as CSS custom properties.
updateIntervalMs-numberSampling window in milliseconds. Defaults to 500.

Released under the MIT License.