kovidgoyal/kitty
1
1
Fork 0
mirror of https://github.com/kovidgoyal/kitty.git synced 2024-11-14 12:11:12 +03:00
Code Issues Projects Releases Wiki Activity

Graphics protocol: Specify some edge case behavior for image display

Browse Source 
See https://github.com/kovidgoyal/kitty/discussions/6979
This commit is contained in:
Kovid Goyal 2024-01-08 08:46:17 +05:30
parent 7427e65f60
commit b8c5c62585
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/graphics-protocol.rst
View File

@ -484,13 +484,17 @@ a different origin within the cell. Note that the offsets must be smaller than t
By default, the entire image will be displayed (images wider than the available
width will be truncated on the right edge). You can choose a source rectangle (in pixels)
as the part of the image to display. This is done with the keys: ``x, y, w, h`` which specify
the top-left corner, width and height of the source rectangle.
the top-left corner, width and height of the source rectangle. The displayed
area is the intersection of the specified rectangle with the source image
rectangle.
You can also ask the terminal emulator to display the image in a specified rectangle
(num of columns / num of lines), using the control codes ``c,r``. ``c`` is the number of columns
and `r` the number of rows. The image will be scaled (enlarged/shrunk) as needed to fit
the specified area. Note that if you specify a start cell offset via the ``X,Y`` keys, it is not
added to the number of rows/columns.
added to the number of rows/columns. If only one of either ``r`` or ``c`` is
specified, the other one is computed based on the source image aspect ratio, so
that the image is displayed without distortion.
Finally, you can specify the image *z-index*, i.e. the vertical stacking order. Images
placed in the same location with different z-index values will be blended if