Logo Mibo

Diagnostics Module

Access to the frame profiler and a display helper.

Functions and values

Function or value Description

format stats

Full Usage: format stats

Parameters:
Returns: string

Formats a snapshot as two short lines for a text overlay.

The first line holds rates and costs. The second holds allocation, collection, and graphics counts. Call this once per window, not once per frame, because it allocates.

stats : FrameStats
Returns: string

getProfiler ctx

Full Usage: getProfiler ctx

Parameters:
Returns: FrameProfiler
Modifiers: inline

Returns the registered profiler.

ctx : GameContext
Returns: FrameProfiler
System.Exception Thrown when no profiler is registered.

tryGetProfiler ctx

Full Usage: tryGetProfiler ctx

Parameters:
Returns: FrameProfiler voption
Modifiers: inline

Returns the registered profiler, or ValueNone.

ctx : GameContext
Returns: FrameProfiler voption

Type something to start searching.