starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Background color handling changed between 1.1 and 1.2 #10595

New Issue
Closed
opened 2026-01-31 02:25:26 +00:00 by claunia · 5 comments
claunia commented 2026-01-31 02:25:26 +00:00
Owner
Copy Link

Originally created by @thomthom on GitHub (Sep 11, 2020).

Environment

Windows build number: Microsoft Windows [Version 10.0.18363.900] and Microsoft Windows [Version 10.0.19041.450]
Windows Terminal version (if applicable):

Any other software?
PDCurses: https://github.com/wmcbrine/PDCurses @ 618e0aa

Steps to reproduce

Related to the same PDCurses based application that prompted me to report #7594 I found something else. The background handling in Windows Terminal changed between 1.1 and 1.2.

In my app I declare a custom color:

  #define SW_COLOR_DEBUG 100
  init_color(SW_COLOR_DEBUG, 500, 500, 500);
  init_pair(1, SW_COLOR_DEBUG, COLOR_BLACK);

Expected behavior

What I saw in WT 1.1 was what this:

wt-1 1

I wasn't sure if it would work like that, since I had custom non-black background, but I had hoped the black color was remapped.
COLOR_BLACK is defined as 0 in PDCurses, I didn't find any way to set no color.

Actual behavior

In WT 1.2 I'm now seeing actual black.

wt-1 2

I'm not 100% sure what is technically correct here, if I'd seen WT1.2 first I would have assumed my code was wrong, but since there's behaviour change between 1.1 I figured I'd report this.

Originally created by @thomthom on GitHub (Sep 11, 2020). # Environment ```none Windows build number: Microsoft Windows [Version 10.0.18363.900] and Microsoft Windows [Version 10.0.19041.450] Windows Terminal version (if applicable): ``` Any other software? PDCurses: https://github.com/wmcbrine/PDCurses @ [618e0aa](https://github.com/wmcbrine/PDCurses/commit/618e0aaa31b4728eb4df78ec4de6c2b873908eda) # Steps to reproduce Related to the same PDCurses based application that prompted me to report #7594 I found something else. The background handling in Windows Terminal changed between 1.1 and 1.2. In my app I declare a custom color: ``` #define SW_COLOR_DEBUG 100 init_color(SW_COLOR_DEBUG, 500, 500, 500); init_pair(1, SW_COLOR_DEBUG, COLOR_BLACK); ``` # Expected behavior What I saw in WT 1.1 was what this: ![wt-1 1](https://user-images.githubusercontent.com/192418/92892755-5673a280-f419-11ea-92ae-ba628e6902dc.png) I wasn't sure if it would work like that, since I had custom non-black background, but I had hoped the black color was remapped. `COLOR_BLACK` is defined as `0` in PDCurses, I didn't find any way to set no color. # Actual behavior In WT 1.2 I'm now seeing actual black. ![wt-1 2](https://user-images.githubusercontent.com/192418/92893014-963a8a00-f419-11ea-81a0-bbf4d3e77507.png) I'm not 100% sure what is technically correct here, if I'd seen WT1.2 first I would have assumed my code was wrong, but since there's behaviour change between 1.1 I figured I'd report this.
claunia added the Resolution-By-DesignNeeds-Tag-Fix labels 2026-01-31 02:25:26 +00:00
claunia commented 2026-01-31 02:25:27 +00:00
Author
Owner
Copy Link

@WSLUser commented on GitHub (Sep 11, 2020):

https://github.com/microsoft/terminal/pull/6506 changed it so now the correct behavior is defined. So yes you need to update your code.

@WSLUser commented on GitHub (Sep 11, 2020): https://github.com/microsoft/terminal/pull/6506 changed it so now the correct behavior is defined. So yes you need to update your code.
claunia commented 2026-01-31 02:25:27 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Sep 11, 2020):

Yep. There's a similar issue that existed in powershell until we fixed it. It explains a bit about why this happens.

https://github.com/PowerShell/PSReadLine/issues/830#issuecomment-650508857

@DHowett commented on GitHub (Sep 11, 2020): Yep. There's a similar issue that existed in powershell until we fixed it. It explains a bit about why this happens. https://github.com/PowerShell/PSReadLine/issues/830#issuecomment-650508857
claunia commented 2026-01-31 02:25:27 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Sep 11, 2020):

(thanks @WSLUser)

@DHowett commented on GitHub (Sep 11, 2020): (thanks @WSLUser)
claunia commented 2026-01-31 02:25:27 +00:00
Author
Owner
Copy Link

@thomthom commented on GitHub (Sep 11, 2020):

Thanks for the references. I'll read through that and see if I can apply it to PDCurses. I think nurses let you use -1 as "no color change" but PDCurses doesn't seem to allow that. Maybe I have to propose a change to PDCurses.

@thomthom commented on GitHub (Sep 11, 2020): Thanks for the references. I'll read through that and see if I can apply it to PDCurses. I think nurses let you use `-1` as "no color change" but PDCurses doesn't seem to allow that. Maybe I have to propose a change to PDCurses.
claunia commented 2026-01-31 02:25:28 +00:00
Author
Owner
Copy Link

@thomthom commented on GitHub (Sep 12, 2020):

I've been reading the references, but I still don't fully understand what is going on. I made some additional tests:

#include <cassert>
#include <iomanip>
#include <iostream>

#include <curses.h>

#define ISOK(api_function_call) {\
  [[maybe_unused]] int curses_result = api_function_call;\
  if(curses_result != OK)\
    std::cout << "Curses Error: " << curses_result << "\n";\
  assert(curses_result == OK);\
}

void print_input(int input);

int main()
{
  initscr();
  start_color();
  use_default_colors();
  // assume_default_colors(-1, -1);
  raw();
  keypad(stdscr, TRUE);
  noecho();

  mousemask(BUTTON1_CLICKED, nullptr);

  move(1, 1);
  attron(A_BOLD);
  printw("PDCurses Mouse Test");
  attroff(A_BOLD);

  mvprintw(5, 1, "has_colors: %d", has_colors());
  mvprintw(6, 1, "can_change_color: %d", can_change_color());
  mvprintw(7, 1, "COLORS: %d", COLORS);
  mvprintw(8, 1, "COLOR_PAIRS: %d", COLOR_PAIRS);

  short r, g, b;
  color_content(0, &r, &g, &b);
  mvprintw(10, 1, "COLOR_BLACK: %d, %d, %d", r, g, b);

  const int kColorDefaultBg = 200;
  ISOK(init_color(kColorDefaultBg, r, g, b));

  const int kColorDebug = 210;
  ISOK(init_color(kColorDebug, r + 30, g + 20, b + 10));

  ISOK(init_pair(1, COLOR_RED, COLOR_BLACK));
  ISOK(init_pair(2, COLOR_GREEN, COLOR_BLACK));
  ISOK(init_pair(3, COLOR_BLUE, COLOR_BLACK));
  ISOK(init_pair(4, COLOR_CYAN, COLOR_BLACK));
  ISOK(init_pair(5, COLOR_MAGENTA, COLOR_BLACK));
  ISOK(init_pair(6, COLOR_YELLOW, COLOR_BLACK));

  ISOK(init_pair(10, COLOR_RED, -1));

  const int kColorGrey = 100;
  ISOK(init_color(kColorGrey, 500, 500, 500));
  ISOK(init_pair(11, kColorGrey, COLOR_BLACK));
  ISOK(init_pair(12, kColorGrey, -1));

  ISOK(init_pair(13, COLOR_RED, kColorDefaultBg));
  ISOK(init_pair(14, kColorGrey, kColorDefaultBg));
  ISOK(init_pair(15, COLOR_RED, kColorDebug));

  const int kTop = 12;
  for (int i = 0; i < 16; ++i) {
    auto result = color_set(i, NULL);
    mvprintw(kTop + i, 1, "Color Set: %d", i);

    attron(A_BOLD);
    mvprintw(kTop + i, 20, "Color Set: %d", i);
    attroff(A_BOLD);

    attron(A_DIM);
    mvprintw(kTop + i, 40, "Color Set: %d", i);
    attroff(A_DIM);

    attron(A_STANDOUT);
    mvprintw(kTop + i, 60, "Color Set: %d", i);
    attroff(A_STANDOUT);
  }

  bool run = true;
  while(run) {
    refresh();
    int input = getch();

    switch(input) {
    case 'q':
      run = false;
      break;
    default:
      print_input(input);
    }
  }

  endwin();
  return 0;
}

The result in WT 1.2 is:

image

Here is what I don't fully understand:

When I use only the predefined COLOR_ macros in PDCurses and COLOR_BLACK as background it looks fine. (Color set 1-6)

In color set 10 I set foreground to COLOR_RED and background to -1 which also looks fine. (-1 gets normalized to 0 so it ends up being the same as COLOR_BLACK.

But, with any custom foreground color, the background is 0, 0, 0. Set 11 and 12 both ends up passing color 0 from PDCurses, similar to line 10. But yet they render with different color?

From what I understand there are some color mapping going on, but is the logic different if either foreground or background is different from the default colors (or different from one of the indexed 0-16 colors)? Does a custom foreground color affect how the background color is mapped? (If not, why would set 11 and 12 have different background from 10 in the example above?)

I why is 12-13 using black background when I define a color that is the same as the terminal defines? (Which I can even read back from color 0.)
(Edit: Never mind this color set 12-13, I forgot the colors from PDCurses are 0-1000 and 47 is a very low value. So I don't understand where that value comes from.)

I found this article: https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#extended-colors
But I'm not sure if that relate only to cmd.exe?

@thomthom commented on GitHub (Sep 12, 2020): I've been reading the references, but I still don't fully understand what is going on. I made some additional tests: ```cpp #include <cassert> #include <iomanip> #include <iostream> #include <curses.h> #define ISOK(api_function_call) {\ [[maybe_unused]] int curses_result = api_function_call;\ if(curses_result != OK)\ std::cout << "Curses Error: " << curses_result << "\n";\ assert(curses_result == OK);\ } void print_input(int input); int main() { initscr(); start_color(); use_default_colors(); // assume_default_colors(-1, -1); raw(); keypad(stdscr, TRUE); noecho(); mousemask(BUTTON1_CLICKED, nullptr); move(1, 1); attron(A_BOLD); printw("PDCurses Mouse Test"); attroff(A_BOLD); mvprintw(5, 1, "has_colors: %d", has_colors()); mvprintw(6, 1, "can_change_color: %d", can_change_color()); mvprintw(7, 1, "COLORS: %d", COLORS); mvprintw(8, 1, "COLOR_PAIRS: %d", COLOR_PAIRS); short r, g, b; color_content(0, &r, &g, &b); mvprintw(10, 1, "COLOR_BLACK: %d, %d, %d", r, g, b); const int kColorDefaultBg = 200; ISOK(init_color(kColorDefaultBg, r, g, b)); const int kColorDebug = 210; ISOK(init_color(kColorDebug, r + 30, g + 20, b + 10)); ISOK(init_pair(1, COLOR_RED, COLOR_BLACK)); ISOK(init_pair(2, COLOR_GREEN, COLOR_BLACK)); ISOK(init_pair(3, COLOR_BLUE, COLOR_BLACK)); ISOK(init_pair(4, COLOR_CYAN, COLOR_BLACK)); ISOK(init_pair(5, COLOR_MAGENTA, COLOR_BLACK)); ISOK(init_pair(6, COLOR_YELLOW, COLOR_BLACK)); ISOK(init_pair(10, COLOR_RED, -1)); const int kColorGrey = 100; ISOK(init_color(kColorGrey, 500, 500, 500)); ISOK(init_pair(11, kColorGrey, COLOR_BLACK)); ISOK(init_pair(12, kColorGrey, -1)); ISOK(init_pair(13, COLOR_RED, kColorDefaultBg)); ISOK(init_pair(14, kColorGrey, kColorDefaultBg)); ISOK(init_pair(15, COLOR_RED, kColorDebug)); const int kTop = 12; for (int i = 0; i < 16; ++i) { auto result = color_set(i, NULL); mvprintw(kTop + i, 1, "Color Set: %d", i); attron(A_BOLD); mvprintw(kTop + i, 20, "Color Set: %d", i); attroff(A_BOLD); attron(A_DIM); mvprintw(kTop + i, 40, "Color Set: %d", i); attroff(A_DIM); attron(A_STANDOUT); mvprintw(kTop + i, 60, "Color Set: %d", i); attroff(A_STANDOUT); } bool run = true; while(run) { refresh(); int input = getch(); switch(input) { case 'q': run = false; break; default: print_input(input); } } endwin(); return 0; } ``` The result in WT 1.2 is: ![image](https://user-images.githubusercontent.com/192418/92995207-ac237a00-f501-11ea-9707-2f22eefc89f7.png) Here is what I don't fully understand: When I use only the predefined `COLOR_` macros in PDCurses and `COLOR_BLACK` as background it looks fine. (Color set 1-6) In color set 10 I set foreground to `COLOR_RED` and background to `-1` which also looks fine. (`-1` gets normalized to `0` so it ends up being the same as `COLOR_BLACK`. But, with any custom foreground color, the background is `0, 0, 0`. Set 11 and 12 both ends up passing color `0` from PDCurses, similar to line 10. But yet they render with different color? From what I understand there are some color mapping going on, but is the logic different if either foreground or background is different from the default colors (or different from one of the indexed 0-16 colors)? Does a custom foreground color affect how the background color is mapped? (If not, why would set 11 and 12 have different background from 10 in the example above?) I why is 12-13 using black background when I define a color that is the same as the terminal defines? (Which I can even read back from color 0.) (**Edit:** Never mind this color set 12-13, I forgot the colors from PDCurses are 0-1000 and `47` is a very low value. So I don't understand where that value comes from.) I found this article: https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#extended-colors But I'm not sure if that relate only to `cmd.exe`?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Needs-Tag-Fix Resolution-By-Design
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#10595
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?