diff options
author | Kenny Levinsen <kl@kl.wtf> | 2020-05-01 17:20:41 +0200 |
---|---|---|
committer | Simon Ser <contact@emersion.fr> | 2020-05-11 10:36:33 +0200 |
commit | a8a6ed667d0f9fe747a86bd8607f875e097e3af5 (patch) | |
tree | 0aa0a359bd91f506a1b98fc0f90f7f7d631b64e3 /sway/sway.5.scd | |
parent | Fix some mistakes in grimshot docs (diff) | |
download | sway-a8a6ed667d0f9fe747a86bd8607f875e097e3af5.tar.gz sway-a8a6ed667d0f9fe747a86bd8607f875e097e3af5.tar.zst sway-a8a6ed667d0f9fe747a86bd8607f875e097e3af5.zip |
Simplify repaint scheduling documentation
The current documentation for repaint scheduling is very technical and
somewhat confusing.
Closes: https://github.com/swaywm/sway/issues/4769
Diffstat (limited to 'sway/sway.5.scd')
-rw-r--r-- | sway/sway.5.scd | 24 |
1 files changed, 16 insertions, 8 deletions
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 <amount> | |||
186 | Cycles the layout mode of the focused container through a list of layouts. | 186 | Cycles the layout mode of the focused container through a list of layouts. |
187 | 187 | ||
188 | *max_render_time* off|<msec> | 188 | *max_render_time* off|<msec> |
189 | Works together with *output max_render_time* to reduce the latency even | 189 | Controls when the relevant application is told to render this window, as a |
190 | further by delaying the frame callbacks sent to a surface. When set to | 190 | positive number of milliseconds before the next time sway composites the |
191 | a positive number of milliseconds, delays the frame callback in such a | 191 | output. A smaller number leads to fresher rendered frames being composited |
192 | way that the surface has the specified number of milliseconds to render | 192 | by sway and lower perceived input latency, but if set too low, the |
193 | and commit new contents before being sampled by the compositor for the | 193 | application may not finish rendering before sway composites the output, |
194 | next presentation. See *max_render_time* in *sway-output*(5) for | 194 | leading to delayed frames. |
195 | further details. | 195 | |
196 | When set to off, the relevant application is told to render this window | ||
197 | immediately after display refresh. How much time is left for rendering | ||
198 | before sway composites the output at that point depends on the output | ||
199 | *max_render_time* setting. | ||
196 | 200 | ||
197 | To set this up for optimal latency: | 201 | To set this up for optimal latency: |
198 | . Set up *output max_render_time*. | 202 | . Set up *output max_render_time* (see *sway-output*(5)). |
199 | . Put the target application in _full-screen_ and have it continuously | 203 | . Put the target application in _full-screen_ and have it continuously |
200 | render something. | 204 | render something. |
201 | . Start by setting *max_render_time 1*. If the application drops | 205 | . Start by setting *max_render_time 1*. If the application drops |
202 | frames, increment by *1*. | 206 | frames, increment by *1*. |
203 | 207 | ||
208 | This setting only has an effect if a per-output *max_render_time* is in | ||
209 | effect on the output the window is currently on. See *sway-output*(5) for | ||
210 | further details. | ||
211 | |||
204 | *move* left|right|up|down [<px> px] | 212 | *move* left|right|up|down [<px> px] |
205 | Moves the focused container in the direction specified. If the container, | 213 | Moves the focused container in the direction specified. If the container, |
206 | the optional _px_ argument specifies how many pixels to move the container. | 214 | the optional _px_ argument specifies how many pixels to move the container. |