StatsWidget (Experimental)
Displays performance and debugging statistics from deck.gl, luma.gl, or custom probe.gl stats objects in a collapsible widget.
Usage
import {Deck} from '@deck.gl/core';
import {_StatsWidget as StatsWidget} from '@deck.gl/widgets';
const deck = new Deck({
widgets: [
new StatsWidget({
type: 'deck',
framesPerUpdate: 5
})
]
});
Types
StatsWidgetProps
The StatsWidget
accepts the generic WidgetProps
and:
type
(string, default'deck'
) - Type of stats to display:'deck'
,'luma'
,'device'
, or'custom'
stats
(Stats, optional) - Custom stats object when usingtype: 'custom'
title
(string, default'Stats'
) - Title shown in the widget headerframesPerUpdate
(number, default1
) - Number of frames to wait between updatesformatters
(object, default{}
) - Custom formatters for stat valuesresetOnUpdate
(object, default{}
) - Whether to reset particular stats after each update
Built-in Formatters
'count'
- Display raw count value'averageTime'
- Format as average time in ms/s'totalTime'
- Format as total time in ms/s'fps'
- Format as frames per second'memory'
- Format as memory in MB
Behavior
- Click the header to expand/collapse the stats display
- Stats are automatically updated based on
framesPerUpdate
- Different stat types provide access to various performance metrics:
'deck'
: deck.gl rendering statistics'luma'
: luma.gl WebGL statistics'device'
: GPU device statistics'custom'
: User-provided stats object