From 1915e53629f93184e3b82d73dea2bd22cc5a780c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sat, 27 Jun 2020 15:32:33 +0200 Subject: [PATCH] sixel: improve descriptions of sixel_delete_* and sixel_overwrite_* --- sixel.h | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/sixel.h b/sixel.h index 6b272e94..bb3eb730 100644 --- a/sixel.h +++ b/sixel.h @@ -12,13 +12,23 @@ void sixel_unhook(struct terminal *term); void sixel_destroy(struct sixel *sixel); -/* Deletes all sixels that are touched by the specified row(s). Row - * numbers are relative to the current grid aoffset */ +/* + * Deletes all sixels that are touched by the specified row(s). Used + * when scrolling, to competely remove sixels that has either + * completely, or partly scrolled out of history. + * + * Row numbers are relative to the current grid offset. + */ void sixel_delete_in_range(struct terminal *term, int row_start, int row_end); void sixel_delete_at_row(struct terminal *term, int row); -/* Remove sixel data from the specified location. Row numbers are - * relative to the current grid offset */ +/* + * Remove sixel data from the specified location. Used when printing + * or erasing characters, and when emitting new sixel images, to + * remove sixel data that would otherwise be rendered on-top. + * + * Row numbers are relative to the current grid offset + */ void sixel_overwrite_by_rectangle( struct terminal *term, int row, int col, int height, int width); void sixel_overwrite_by_row(struct terminal *term, int row, int col, int width);