Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix lines in kitty terminal with text_fg_override_threshold set #197

Merged
merged 3 commits into from
Nov 2, 2023

Conversation

joveian
Copy link
Contributor

@joveian joveian commented Oct 30, 2023

The kitty terminal has a new setting text_fg_override_threshold that checks the luminosity difference between the text and background and if it is above the set percentage turns the text black or white to get the best possible visibility. pastel currently uses a unicode half block character and sets both forground and background to the same color in the color patch. This patch changes this to be a space with both forground and background colors set to the same color (only becuase I don't know enough rust to figure out how to just set background color :/).

Possibly this could cause trouble with some background transparency settings, although if so the current situation might as well to a lesser extent. I'm not sure how to make using text color work reliably with text_fg_override_threshold so I think a command line option to use one or the other would be needed there unless another drawing option is used.

There are two other ways to draw on kitty that could be considered. The graphics protocol allow arbitrary images to be displayed and is supported by a few other terminals. kitty also supports using colors with DECCARA, although I don't know if any other terminals support this. In any case, with this patch it works for me and I checked that it still works on alacritty as well.

The kitty terminal has a new setting text_fg_override_threshold that checks
the luminosity difference between the text and background and if it is above
the set percentage turns the text black or white to get the best possible
visibility.  pastel currently uses a unicode half block character and sets
both forground and background to the same color in the color patch.  This
patch changes this to be a space with both forground and background colors set
to the same color (only becuase I don't know enough rust to figure out how to
just set background color :/).

Possibly this could cause trouble with some background transparency settings,
although if so the current situation might as well to a lesser extent.  I'm
not sure how to make using text color work reliably with
text_fg_override_threshold so I think a command line option to use one or the
other would be needed there unless another drawing option is used.

There are two other ways to draw on kitty that could be considered.  The
graphics protocol allow arbitrary images to be displayed and is supported by a
few other terminals.  kitty also supports using colors with DECCARA, although
I don't know if any other terminals support this.  In any case, with this
patch it works for me and I checked that it still works on alacritty as well.
@sharkdp
Copy link
Owner

sharkdp commented Nov 2, 2023

The kitty terminal has a new setting text_fg_override_threshold that checks the luminosity difference between the text and background and if it is above the set percentage turns the text black or white to get the best possible visibility.

I saw the upstream issue (kovidgoyal/kitty#6767). Is the strategy really to try and fix every program that uses "last century" mechanisms for drawing in the terminal?

There are two other ways to draw on kitty that could be considered. The graphics protocol allow arbitrary images to be displayed and is supported by a few other terminals.

If you want to explore this, this sounds like a great idea. This could certainly result in nicer graphics for those terminals that support the protocol. Maybe we could open a new issue for this, listing potential benefits.

"{}",
self.brush.paint(" ", top.ansi_style().on(bottom))
)?
} else {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about the else path? Isn't that still potentially causing problems if kitty changes colors?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potentially, however I think it is only used in the checkerboard, which has a fairly high luminosity difference. I think kitty uses a simple percentage luminosity difference (I want to work on the compare functionality from #21 next and would like to add the value that kitty uses). I set it to 40 which seems high enough to avoid issues with text and the checkerboard still works. Maybe a comment about this potential issue would be appropriate to avoid it being used for something else in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just checked and 40 is the highest value of text_fg_override_threshold that the current checkerboard works with, so I guess that would be a potential reason to use the graphics protocol, although I'm not sure if anyone will want to set it higher than that. Does look a bit odd when it triggers.

@joveian
Copy link
Contributor Author

joveian commented Nov 2, 2023

Is the strategy really to try and fix every program that uses "last century" mechanisms for drawing in the terminal?

I don't think there is any intent to remove support for ANSI color. The one color related thing that kitty doesn't support (and I don't think ever has) is the background color erase (bce) functionality due to major issues with the design (and as a result conflicting implementations).

Unfortunately, the text_fg_override_threshold setting is quite useful because of the variety of terminal color settings and the many programs that just use what works for the developer without options to change color (or just it being very annoying to change all the colors). I suspect there are many fewer non-text uses of low luminosity fg vs bg color combinations and some of those would be better off applying the override. Personally I would like web browsers to implement this feature as well to fix the occasional unreadable page.

If you want to explore this, this sounds like a great idea. This could certainly result in nicer graphics for those terminals that support the protocol. Maybe we could open a new issue for this, listing potential benefits.

I'm not sure using the graphics protocol would really make much difference for what pastel does. Unless you want to use harfbuzz to produce proportional font example text or something like that? Or if there turn out to be background transparency issues that using the graphics protocol fixes.

@sharkdp sharkdp merged commit f205dec into sharkdp:master Nov 2, 2023
15 checks passed
@sharkdp
Copy link
Owner

sharkdp commented Nov 2, 2023

Ok, thank you for the explanations. I guess there's no harm in merging this if it helps kitty users.

I'm not sure using the graphics protocol would really make much difference for what pastel does.

Ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants