From a8a6ed667d0f9fe747a86bd8607f875e097e3af5 Mon Sep 17 00:00:00 2001 From: Kenny Levinsen Date: Fri, 1 May 2020 17:20:41 +0200 Subject: Simplify repaint scheduling documentation The current documentation for repaint scheduling is very technical and somewhat confusing. Closes: https://github.com/swaywm/sway/issues/4769 --- sway/sway.5.scd | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) (limited to 'sway/sway.5.scd') diff --git a/sway/sway.5.scd b/sway/sway.5.scd index bbcc94e2..febf749f 100644 --- a/sway/sway.5.scd +++ b/sway/sway.5.scd @@ -186,21 +186,29 @@ set|plus|minus Cycles the layout mode of the focused container through a list of layouts. *max_render_time* off| - Works together with *output max_render_time* to reduce the latency even - further by delaying the frame callbacks sent to a surface. When set to - a positive number of milliseconds, delays the frame callback in such a - way that the surface has the specified number of milliseconds to render - and commit new contents before being sampled by the compositor for the - next presentation. See *max_render_time* in *sway-output*(5) for - further details. + Controls when the relevant application is told to render this window, as a + positive number of milliseconds before the next time sway composites the + output. A smaller number leads to fresher rendered frames being composited + by sway and lower perceived input latency, but if set too low, the + application may not finish rendering before sway composites the output, + leading to delayed frames. + + When set to off, the relevant application is told to render this window + immediately after display refresh. How much time is left for rendering + before sway composites the output at that point depends on the output + *max_render_time* setting. To set this up for optimal latency: - . Set up *output max_render_time*. + . Set up *output max_render_time* (see *sway-output*(5)). . Put the target application in _full-screen_ and have it continuously render something. . Start by setting *max_render_time 1*. If the application drops frames, increment by *1*. + This setting only has an effect if a per-output *max_render_time* is in + effect on the output the window is currently on. See *sway-output*(5) for + further details. + *move* left|right|up|down [ px] Moves the focused container in the direction specified. If the container, the optional _px_ argument specifies how many pixels to move the container. -- cgit v1.2.3-54-g00ecf