Created attachment 150416 [details] different behaviours with sixel images of konsole and xterm vt340 SUMMARY *** NOTE: If you are reporting a crash, please try to attach a backtrace with debug symbols. See https://community.kde.org/Guidelines_and_HOWTOs/Debugging/How_to_create_useful_crash_reports *** in other terminals such as foot, mlterm and xterm (emulating vt-340) , when new text is written where a sixel image is present, part of the image is erased. In Konsole, the text is written on top of the image instead. The erasing behaviour can be useful to TUI apps for deleting an image without needing to clear the entire screen. STEPS TO REPRODUCE 1. print a sixel image 2. move cursor to somewhere in the image and print a normal string Here's a sample shell script with outputs in the attached picture ``` #!/bin/sh clear printf '\x1b[2;2H' printf '\x1bP0;1;0q#0;2;50;49;99#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-\x1b\\' printf '\x1b[2;2H' printf 'Sample Text Here' printf '\n\n' ``` OBSERVED RESULT Text written on top of image EXPECTED RESULT Text overwrites/erases part of the image SOFTWARE/OS VERSIONS Windows: macOS: Linux/KDE Plasma: Arch Linux kernel 5.18.9-zen (available in About System) KDE Plasma Version: 5.25.2 KDE Frameworks Version: 5.95.0 Qt Version: 5.15.5 ADDITIONAL INFORMATION
Explanation for the example script: ``` #!/bin/sh clear # move cursor to position (2, 2) printf '\x1b[2;2H' # print a purple rectangle using SIXEL printf '\x1bP0;1;0q#0;2;50;49;99#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-#0!255~-\x1b\\' # move cursor back to position (2, 2) printf '\x1b[2;2H' # write some text printf 'Sample Text Here' printf '\n\n' ```
(In reply to badnam3o.0 from comment #0) > Created attachment 150416 [details] > different behaviours with sixel images of konsole and xterm vt340 > > in other terminals such as foot, mlterm and xterm (emulating vt-340) , when > new text is written where a sixel image is present, part of the image is > erased. In Konsole, the text is written on top of the image instead. The > erasing behaviour can be useful to TUI apps for deleting an image without > needing to clear the entire screen. This was a conscious decision by me. While the interaction between text and image you describe is common, or even universal, I do not think it was in any way defined formally in any standard. In KDE, the default background color was always treated as transparent (see when a background image is used). So an application may get the common behaviour of text hiding image by changing the background color to a similar color (like (1,1,1) instead of (0,0,0)), while having the option of mixing text and graphics.
(In reply to Matan Ziv-Av from comment #2) > (In reply to badnam3o.0 from comment #0) > > Created attachment 150416 [details] > > different behaviours with sixel images of konsole and xterm vt340 > > > > in other terminals such as foot, mlterm and xterm (emulating vt-340) , when > > new text is written where a sixel image is present, part of the image is > > erased. In Konsole, the text is written on top of the image instead. The > > erasing behaviour can be useful to TUI apps for deleting an image without > > needing to clear the entire screen. > > This was a conscious decision by me. While the interaction between text and > image you describe is common, or even universal, I do not think it was in > any way defined formally in any standard. > > In KDE, the default background color was always treated as transparent (see > when a background image is used). > > So an application may get the common behaviour of text hiding image by > changing the background color to a similar color (like (1,1,1) instead of > (0,0,0)), while having the option of mixing text and graphics. Please, remove this change. Many applications rely on ability to erase sixels by writing text over it.
please keep this change, i'm making a TUI app, and have a special case for Konsole to draw extra text ontop of Sixels. Maybe an escape sequence could be added to enable or disable this as a feature. I also don't mind Matan's proposal that the TUI developer should just set the background color for the text before drawing ontop of a sixel to force erase of the sixel underneath. In other terminals, when drawing text ontop of sixels, i already set the background color to match the average sixel color, that way it more closely matches how Konsole works now.
Created attachment 167360 [details] screenshot-broken-tmux
You should provide the common behaviour by default, and the modified behaviour by choice. I expect this to break every application out there using sixel. See TMUX in the attachment. Not even scrolling works. Can you point us to the bit of code in konsole where this choice was made, so I can patch my version? Thanks!
This is far from a trivial change. This simple patch changes behaviour of sixel images, but breaks at least kitty images, terminal background image, and terminal background transparency. To correctly implement this, it is needed to know at the time of drawing text background if underneath it is a sixel image, another image, transparent background, etc. diff --git a/src/Screen.cpp b/src/Screen.cpp index f5047d1f17..626292a098 100644 --- a/src/Screen.cpp +++ b/src/Screen.cpp @@ -2523,7 +2523,14 @@ void Screen::addPlacement(QPixmap pixmap, addPlacement(p); int needScroll = qBound(0, row + rows - _lines, rows); if (moveCursor && scrolling && needScroll > 0) { - scrollUp(needScroll); + if (!leaveText) { + for (int i = needScroll; i > 0; i--) { + scrollUp(1); + eraseBlock(_lines - 2, col, 1, cols); + } + } else { + scrollUp(needScroll); + } } if (moveCursor) { if (rows - needScroll - 1 > 0) { @@ -2532,6 +2539,9 @@ void Screen::addPlacement(QPixmap pixmap, if (moveCursor == 2 || _cuX + cols >= _columns) { toStartOfLine(); newLine(); + if (!leaveText) { + eraseBlock(_lines - 2, col, rows, cols); + } } else { cursorRight(cols); } diff --git a/src/terminalDisplay/TerminalPainter.cpp b/src/terminalDisplay/TerminalPainter.cpp index f19b0e6245..399b09cb2b 100644 --- a/src/terminalDisplay/TerminalPainter.cpp +++ b/src/terminalDisplay/TerminalPainter.cpp @@ -823,6 +823,7 @@ void TerminalPainter::drawBelowText(QPainter &painter, backgroundColor = background; } drawBG = backgroundColor != colorTable[DEFAULT_BACK_COLOR]; + drawBG = true; if (style[x].rendition.f.transparent) { drawBG = false; }
Created attachment 169563 [details] Screen-shot of Konsole causing breakage to euporie due to this bug This bug also causes breakage of my TUI application (euporie), as shown in the attached screen-shot. I have tested euporie with as many different terminal emulators as possible, and Konsole is the only terminal supporting terminal graphics to display this behaviour. I'm much rather not have to handle Konsole as a special case. Also, erasing graphics by setting the background colour does not work in by case, as need the cell background to be unset so it matches the terminal.
*** Bug 487160 has been marked as a duplicate of this bug. ***
A possibly relevant merge request was started @ https://invent.kde.org/utilities/konsole/-/merge_requests/1031
Git commit cc4539f6bfd8e5b6beac23ecd13897c666e88eaa by Kurt Hindenburg, on behalf of Matan Ziv-Av. Committed on 11/10/2024 at 14:47. Pushed by hindenburg into branch 'master'. Change text over sixel image behaviour to be compatible with xterm With this MR, if a character with the default background color is printed on a sixel image, the background color is displayed rather than considered transparent. In more details: The "standard" (_VT330/VT340 Programmer Reference Manual_) does not define what happens when a character is printed on a sixel image. `xterm`, and some other (maybe all?) terminals implementing sixel protocol chose to hide the image under the whole character cell. `Konsole` always treated the default background color as transparent, which makes sense when there is a background image or when the terminal background is transparent. When implementing graphics I chose to use this behaviour, since it seems more flexible to me. But, there are programs that depend on xterm behaviour, and I read complaints about this in various platforms. For implementing this change it is necessary to store with each image its source protocol (since unlike sixel, `kitty` protocol defines the behaviour as the one currently used in `konsole`.) and when drawing the background of a character to be aware if there is a sixel image under it, in order to not change the behaviour for background image. (MR#1031) M +17 -3 src/Screen.cpp M +3 -0 src/Screen.h M +3 -2 src/Vt102Emulation.cpp M +1 -1 src/characters/Character.h M +15 -5 src/terminalDisplay/TerminalPainter.cpp M +4 -2 src/terminalDisplay/TerminalPainter.h https://invent.kde.org/utilities/konsole/-/commit/cc4539f6bfd8e5b6beac23ecd13897c666e88eaa