Fix continuous re-rendering when a selection exists and window is scrolled

The selection dirty check computed iteration data in a different
coordinate system than apply_selection() used to store last_rendered,
so the two never compared equal when scrolled back, causing the
selection buffer to be re-uploaded and the window redrawn every frame.
Use a common helper for both.

Fixes #10714
This commit is contained in:
Kovid Goyal 2026-10-21 21:07:39 +05:30
parent ef58de6850
commit aef2bc2306
No known key found for this signature in database
GPG key ID: 06BC317B515ACE7C
3 changed files with 52 additions and 5 deletions

View file

@ -236,6 +236,9 @@ Detailed list of changes
Files are now written to a temporary file and renamed into place, so an
interrupted transfer no longer leaves a truncated file behind (:pull:`10713`)
- Fix continuous re-rendering and needless GPU usage when a selection is
present and the window is scrolled back (:iss:`10714`)
- Allow docking kitty windows to the edges of other windows or of the tab, for
status bars, file trees, etc. Create them with :code:`launch --type=window-dock`
or :code:`launch --type=tab-dock`, see :ref:`docks`

View file

@ -4346,9 +4346,15 @@ iteration_data_is_empty(const Screen *self, const IterationData *idata) {
return true;
}
static void
render_iteration_data(const Screen *self, const Selection *s, IterationData *ans) {
// Must be used for both rendering and the dirty check so that they compare equal when nothing has changed
iteration_data(s, ans, self->columns, -self->historybuf->count, 0);
}
static void
apply_selection(Screen *self, uint8_t *data, Selection *s, uint8_t set_mask, int extra_leading_rows, int scrolled_by) {
iteration_data(s, &s->last_rendered, self->columns, -self->historybuf->count, 0);
render_iteration_data(self, s, &s->last_rendered);
Line *line;
const int y_min = MAX(-extra_leading_rows - scrolled_by, s->last_rendered.y), y_limit = MIN(s->last_rendered.y_limit, (int)self->lines - scrolled_by);
for (int y = y_min; y < y_limit; y++) {
@ -4375,7 +4381,6 @@ apply_selection(Screen *self, uint8_t *data, Selection *s, uint8_t set_mask, int
}
}
}
s->last_rendered.y = MAX(0, s->last_rendered.y);
}
bool
@ -6177,11 +6182,11 @@ screen_is_selection_dirty(Screen *self) {
self->extra_cursors.dirty)
return true;
for (size_t i = 0; i < self->selections.count; i++) {
iteration_data(self->selections.items + i, &q, self->columns, 0, self->scrolled_by);
render_iteration_data(self, self->selections.items + i, &q);
if (memcmp(&q, &self->selections.items[i].last_rendered, sizeof(IterationData)) != 0) return true;
}
for (size_t i = 0; i < self->url_ranges.count; i++) {
iteration_data(self->url_ranges.items + i, &q, self->columns, 0, self->scrolled_by);
render_iteration_data(self, self->url_ranges.items + i, &q);
if (memcmp(&q, &self->url_ranges.items[i].last_rendered, sizeof(IterationData)) != 0) return true;
}
return false;
@ -7063,9 +7068,16 @@ current_selections(Screen *self, PyObject *a UNUSED) {
PyObject *ans = PyBytes_FromStringAndSize(NULL, (Py_ssize_t)render_lines_for_screen(self) * self->columns);
if (!ans) return NULL;
screen_apply_selection(self, PyBytes_AS_STRING(ans), PyBytes_GET_SIZE(ans));
self->last_rendered.scrolled_by = self->scrolled_by; // mimic what the renderer does
return ans;
}
static PyObject *
is_selection_dirty(Screen *self, PyObject *a UNUSED) {
if (screen_is_selection_dirty(self)) Py_RETURN_TRUE;
Py_RETURN_FALSE;
}
WRAP0(update_only_line_graphics_data)
WRAP0(bell)
@ -7285,7 +7297,7 @@ static PyMethodDef methods[] = {
MND(paste, METH_O) MND(paste_bytes, METH_O) MND(focus_changed, METH_O) MND(has_focus, METH_NOARGS)
MND(has_activity_since_last_focus, METH_NOARGS) MND(copy_colors_from, METH_O) MND(set_marker, METH_VARARGS)
MND(marked_cells, METH_NOARGS) MND(scroll_to_next_mark, METH_VARARGS) MND(update_only_line_graphics_data, METH_NOARGS)
MND(bell, METH_NOARGS) MND(current_selections, METH_NOARGS){
MND(bell, METH_NOARGS) MND(current_selections, METH_NOARGS) MND(is_selection_dirty, METH_NOARGS){
"select_graphic_rendition", (PyCFunction)_select_graphic_rendition, METH_VARARGS, ""},
{NULL} /* Sentinel */

View file

@ -1178,6 +1178,38 @@ class TestScreen(BaseTest):
# marked (set_mask = 1 for plain selections).
self.assertIn(1, result)
def test_selection_not_dirty_after_render(self):
# Regression test for https://github.com/kovidgoyal/kitty/issues/10714
# selections were considered dirty on every frame when scrolled back,
# causing continuous re-rendering
s = self.create_screen(cols=10, lines=3, scrollback=50)
for i in range(40):
s.draw(f'row{i:03d}')
s.carriage_return()
s.linefeed()
def check(msg):
s.current_selections()
self.assertFalse(s.is_selection_dirty(), msg)
s.start_selection(0, 0)
s.update_selection(2, 1)
check('not scrolled')
for amt in (1, 2, 5, 20):
s.scroll(amt, True)
self.assertTrue(s.is_selection_dirty())
check(f'scrolled by {s.scrolled_by}')
s.clear_selection()
s.start_selection(0, 0)
s.update_selection(2, 1)
check('selection in scrollback')
s.scroll(20, False)
self.assertTrue(s.is_selection_dirty())
check('selection above visible area')
s.update_selection(3, 1)
self.assertTrue(s.is_selection_dirty())
check('updated selection above visible area')
def test_soft_hyphen(self):
s = self.create_screen()
s.draw('a\u00adb')