sixel: improve descriptions of sixel_delete_* and sixel_overwrite_*

This commit is contained in:
Daniel Eklöf 2020-06-27 15:32:33 +02:00
parent 186a07c364
commit 1915e53629
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F

18
sixel.h
View file

@ -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);