shifathosn
/
sharpemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
sharpemu/docs/performance-overlay.md

2.4 KiB
Raw Permalink Blame History

Performance display

Open Options → Rendering, globally or for one game.

  • Performance display: start with statistics on or off.
  • Display mode: Full shows all counters and the frame graph. Minimal shows guest FPS, process CPU usage, process GPU usage, and elapsed session time. Title bar shows the same minimal values in the window title.
  • Screen corner: choose any of the four corners. This setting applies only to the on-screen panel.

F1 toggles the display for the current run. F2 cycles clockwise through the screen corners. Neither key changes saved settings. The next run uses the saved options again. Command+F1 retains its separate Metal HUD shortcut.

SHARPEMU_OVERLAY=0 starts the display hidden, even when the saved option is on. F1 can still show it. RenderDoc's F12 hint remains in the title when available. The operating system does not show a title bar in borderless/fullscreen modes.

The launcher passes these options to the game process, including when a separate emulator path is configured:

--overlay=on|off
--overlay-mode=full|minimal|titlebar
--overlay-corner=topleft|topright|bottomright|bottomleft

Usage values

The panel dimensions are separate constants in PerfOverlay.cs: PanelWidth / PanelHeight for Full, and MinimalPanelWidth / MinimalPanelHeight for Minimal. Both heights are fixed; the renderer clips the panel only when the window is too small.

CPU usage is the emulator process's CPU time divided by wall time and the number of logical processors. GPU usage is the busiest GPU engine used by the emulator process, not GPU memory usage or total usage by all applications.

Windows supplies the GPU Engine performance counters. Collection runs off the render thread and uses the existing statistics refresh interval. Rate counters need two samples. Missing counters, unavailable samples, and other platforms show N/A, not zero. No GPU waits or presentation delays are added.

The full panel keeps cache memory counters and puts CPU/GPU usage on a separate line above elapsed time and the Vulkan allocation counters.

The counter interpretation follows Microsoft's GPU utilization description. Wildcard samples use PdhGetFormattedCounterArray.