From 45d2af73c03265dc8223e4ec59917e8afb613625 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Thu, 5 Nov 2026 17:32:59 +0200 Subject: [PATCH] [doc] performance: Cleanup --- doc/performance.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/doc/performance.rst b/doc/performance.rst index d2768ae4..01b415b9 100644 --- a/doc/performance.rst +++ b/doc/performance.rst @@ -3,8 +3,11 @@ Measure performance and latency ############################### -Press :kbd:`ScrLk` + :kbd:`D` for the compact FPS and UPS display. Press -:kbd:`ScrLk` + :kbd:`T` for the timing graphs. +Press :kbd:`ScrLk` + :kbd:`D` to show the FPS and UPS display. + +Press :kbd:`ScrLk` + :kbd:`T` for the timing graphs. + +.. _client_performance_fps: FPS and UPS ----------- @@ -15,13 +18,15 @@ FPS UPS How often this client consumed a new guest frame. It can be lower than the - guest render rate because cadence deliberately skips frames that were - superseded before the client's next deadline. + guest render rate, as frames will be skipped if they are not displayed before + a new frame is received. -A higher number is not automatically lower latency. Use the stage graph to +A higher number is not automatically lower latency. Use the **stage** graph to find where time is spent and confirm that the displayed rate meets the output you are actually using. +.. _client_latency_graph: + Frame latency graphs -------------------- @@ -101,6 +106,8 @@ for each band are calculated independently, so the top of a minimum or maximum stack can combine stages from different frames. Use those panels to locate stage spikes, not as the measured total of one specific frame. +.. _client_clock_sync: + Cadence and Hold ---------------- @@ -122,6 +129,8 @@ Investigate when Hold repeatedly exceeds roughly one guest frame period, or when jumps occur with large Post, Copy or Ready spikes. Those patterns can indicate server work or scheduling delays rather than normal phase drift. +.. _client_frame_graph: + Frame and photon summaries --------------------------