Engine API Reference - v2.22.0-beta.8
    Preparing search index...

    Class MiniStats

    MiniStats is a small graphical overlay that displays realtime performance metrics. By default, it shows CPU and GPU utilization, frame timings and draw call count. It can also be configured to display additional graphs based on data collected into AppBase#stats.

    The detailed per-frame sub-timings — script, anim, physics and gsplat sort — are measured in every build. The render timing is the exception: its start timestamp is only recorded in the debug and profiler builds, so in the release build the render graph reports the time elapsed since page load rather than a frame time. Import from 'playcanvas/debug' or 'playcanvas/profiler' for a meaningful render figure.

    Index
    constructor
    enabled
    destroy getDefaultOptions

    • Create a new MiniStats instance.

      Parameters

      Returns MiniStats

      // create a new MiniStats instance using default options
      const miniStats = new MiniStats(app);
    • get enabled(): boolean

      Gets the enabled state of the MiniStats overlay.

      Returns boolean

    • set enabled(value: boolean): void

      Sets the enabled state of the MiniStats overlay.

      Parameters

      • value: boolean

      Returns void

    • Destroy the MiniStats instance.

      Returns void

      miniStats.destroy();

    • Returns the default options for MiniStats. The default options configure the overlay to show the following graphs:

      • CPU utilization
      • GPU utilization
      • Overall frame time
      • Draw call count
      • Total VRAM usage

      Parameters

      • OptionalextraStats: string[] = []

        Optional array of preset names from MiniStats.statPresets to include. The preset stats are inserted after the 'Frame' entry. Can be: 'gsplats', 'gsplatsCopy'.

      Returns any

      The default options for MiniStats.

      // default options without extra stats
      const options = MiniStats.getDefaultOptions();

      // include gsplat stats
      const options = MiniStats.getDefaultOptions(['gsplats', 'gsplatsCopy']);

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods