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.

Index

Constructors

constructor

new MiniStats(app: AppBase, options?: MiniStatsOptions): MiniStats
Create a new MiniStats instance.
Parameters
- app: AppBase
  The application.
- Optionaloptions: MiniStatsOptions = ...
  Options for the MiniStats instance.
Returns MiniStats
Example
```
// create a new MiniStats instance using default options
const miniStats = new pc.MiniStats(app);
```
- Defined in extras/mini-stats/mini-stats.js:90

Accessors

enabled

get enabled(): boolean
Gets the enabled state of the MiniStats overlay.

Returns boolean
- Defined in extras/mini-stats/mini-stats.js:428
set enabled(value: boolean): void
Sets the enabled state of the MiniStats overlay.
Parameters
- value: boolean
Returns void
- Defined in extras/mini-stats/mini-stats.js:413

Methods

destroy

destroy(): void
Destroy the MiniStats instance.

Returns void
Example
```
miniStats.destroy();
```
- Defined in extras/mini-stats/mini-stats.js:200

`Static`getDefaultOptions

getDefaultOptions(extraStats?: string[]): any
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.
Example
```
// default options without extra stats
const options = pc.MiniStats.getDefaultOptions();
```
Example
```
// include gsplat stats
const options = pc.MiniStats.getDefaultOptions(['gsplats', 'gsplatsCopy']);
```
- Defined in extras/mini-stats/mini-stats.js:252

Class MiniStats

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MiniStats

Example

Accessors

enabled

Returns boolean

Parameters

Returns void

Methods

destroy

Returns void

Example

`Static`getDefaultOptions

Parameters

Returns any

Example

Example

Settings

On This Page

Class MiniStats

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MiniStats

Example

Accessors

enabled

Returns boolean

Parameters

Returns void

Methods

destroy

Returns void

Example

StaticgetDefaultOptions

Parameters

Returns any

Example

Example

Settings

On This Page

`Static`getDefaultOptions