API ReferenceGE Extensionseditor
Performance Profiler / Camera Recorder
Records FPS and system metrics along camera paths for performance comparison across hardware/settings.
Records FPS and system metrics along camera paths for performance comparison across hardware/settings.
Overview
Records performance data (FPS, draw calls, memory usage) while playing camera paths. Supports loading multiple recordings into chart windows for visual comparison. Includes a table comparator view with configurable columns for system info (CPU, GPU, settings).
Public Functions
| Function | Signature | Description |
|---|---|---|
M.onEditorGui | (dt) | Renders the main profiler window, charts, table comparator, and metadata editor |
M.onEditorInitialized | () | Registers the window under Debug menu |
M.show | () | Shows the profiler window |
M.loadFile | (data) | Loads a .perfRecording.json file and adds it to the comparison set |
Data Keys
| Key | Description |
|---|---|
fps_instant / fps_average / fps_min / fps_max | Frame rate metrics |
fps_waitForGPU | GPU wait time |
gfx_polyCount / gfx_drawCalls | Graphics pipeline stats |
mem_osPhysAvailable / mem_osPhysUsed | OS physical memory |
mem_processPhysUsed / mem_processVirtUsed | Process memory |
Key Features
- Multi-chart windows: Up to 10 simultaneous chart views with selectable data keys
- Recording: Records performance while playing camera paths from
levels/<level>/perfRecordingCampaths/ - Comparator table: Side-by-side comparison of recordings with filterable columns
- Metadata editor: Edit recording names and view detailed info
Usage Example
-- Open from Debug > Performance Recorder
-- Click "Record..." to start a new recording along a camera path
-- Click "Load..." to compare existing .perfRecording.json files
-- Use "New Chart Window" for additional visualization panelsNotes
- Uses
plotHelperUtilfor chart rendering with Catmull-Rom curve smoothing. - Column presets include CPU, GPU, version, and graphics quality settings.
- Search/filter system uses
searchUtilfor fuzzy matching column names. - Recordings include annotation support for marking sections along the path.
See Also
- Editor AI Tests - Related reference
- Editor AI Visualization - Related reference
- Editor – Assembly Spline Tool - Related reference
- World Editor Guide - Guide