get_performance
Measure a Kit app stage's frame rate, frame time, GPU render time and physics performance to verify frame-rate targets and see what scene changes gain.
Instructions
Measure how fast the Kit app runs the open stage: the app loop's frames per second and frame time (mean,
p50, p95, worst) over frames app updates after warmup; the GPU's render time a frame; while the simulation
plays, the physics steps a frame, their time and the simulated-to-real ratio; GPU memory; the stage's prim,
mesh and instance counts; the render products (cameras, lidars) rendering every update; and the conditions to
compare two answers by: the GPU, the Kit app, the renderer, the timeline, headless or not, the frame-rate
limiter, async rendering and eco mode.
Use it to check a frame-rate target, such as 15 FPS with a robot's sensors on, and to see what each cut of the scene gains. Play the simulation first, with the sensors on, so physics and rendering run as they will; a stopped timeline gives no physics numbers. Measure alone: a capture called meanwhile waits for the measurement, and any other call's work counts in its frames. It waits for the stage to finish loading, and stops at 90 s, answering what it measured.
While it measures, Kit's frame-rate limiter is lifted and put back after, so a playing stage with fixed time steps runs faster than real time for those seconds, and a robot driven from outside falls behind meanwhile. The render a capture keeps for the next one is released first, so the next capture sets up its view again. The answer notes when the run's two halves differ by more than 10% (measure again), when eco mode on a still timeline makes the stage read faster than it plays, and when a recording's camera counts in the numbers. The numbers are this machine's and GPU's: measure where the target must be met.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| frames | No | App updates to time, after the warm-up: 120 take 8 s at 15 FPS | |
| warmup | No | App updates to let pass first, once the stage has loaded, so shaders and caches settle |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |