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.

Sign up for GitHub

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

True color #2

Open
wants to merge 8 commits into
base: feature/true-color-support
Choose a base branch
from
Open

True color #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
772d223
Merge remote-tracking branch 'veeman/feature/true-color-support' into…
tznind Dec 4, 2022
e40d871
Merge TrueColorAttribute into Attribute (WIP)
tznind Dec 4, 2022
cef5803
Add HSV based algorithm for fallback color calculation
tznind Dec 4, 2022
5133e02
Added more comprehensive tests and fixed the brown color value
tznind Dec 4, 2022
056137d
Add image scenario
tznind Dec 4, 2022
bb81bc9
Scrap HSV distance for color comparisons and just use RGB
tznind Dec 4, 2022
635b534
Add try/catch for opening image
tznind Dec 4, 2022
9f8efc6
Merge branch 'feature/true-color-support' into true-color
tznind Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Terminal.Gui/ConsoleDrivers/NetDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1526,19 +1526,19 @@ System.Text.StringBuilder WriteAttributes (Attribute attr)
{
System.Text.StringBuilder sb = new System.Text.StringBuilder ();

if ((UseTrueColor) && (attr is TrueColorAttribute tca)) {
if (UseTrueColor) {
sb.Append (new [] { '\x1b', '[', '3', '8', ';', '2', ';' });
sb.Append (tca.TrueColorForeground.Red);
sb.Append (attr.TrueColorForeground.Red);
sb.Append (';');
sb.Append (tca.TrueColorForeground.Green);
sb.Append (attr.TrueColorForeground.Green);
sb.Append (';');
sb.Append (tca.TrueColorForeground.Blue);
sb.Append (attr.TrueColorForeground.Blue);
sb.Append (new [] { ';', '4', '8', ';', '2', ';' });
sb.Append (tca.TrueColorBackground.Red);
sb.Append (attr.TrueColorBackground.Red);
sb.Append (';');
sb.Append (tca.TrueColorBackground.Green);
sb.Append (attr.TrueColorBackground.Green);
sb.Append (';');
sb.Append (tca.TrueColorBackground.Blue);
sb.Append (attr.TrueColorBackground.Blue);
sb.Append ('m');
} else {
const string CSI = "\x1b[";
Expand Down
4 changes: 3 additions & 1 deletion Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,9 @@ private bool WriteConsoleTrueColorOutput(ExtendedCharInfo [] charInfoBuffer)

if (attr != prev) {
prev = attr;
if (attr is TrueColorAttribute tca) {

// TODO: this is now always true
if (attr is Attribute tca) {
stringBuilder.Append (SendTrueColorFg);
stringBuilder.Append (tca.TrueColorForeground.Red);
stringBuilder.Append (';');
Expand Down
172 changes: 140 additions & 32 deletions Terminal.Gui/Core/ConsoleDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,15 +173,24 @@ public class Attribute : IEquatable<Attribute> {
/// <summary>
/// The color attribute value.
/// </summary>
public int Value { get; }
public int Value { get; private set; }
/// <summary>
/// The foreground color.
/// </summary>
public Color Foreground { get; }
public Color Foreground { get; private set; }
/// <summary>
/// The background color.
/// </summary>
public Color Background { get; }
public Color Background { get; private set; }

/// <summary>
/// The foreground color as a <see cref="TrueColor"/>.
/// </summary>
public TrueColor TrueColorForeground { get; private set; }
/// <summary>
/// The background color as a <see cref="TrueColor"/>.
/// </summary>
public TrueColor TrueColorBackground { get; private set; }

/// <summary>
/// Initializes a new instance of the <see cref="Attribute"/> class with only the value passed to
Expand All @@ -199,10 +208,12 @@ public Attribute (int value = 0)
Value = value;
Foreground = foreground;
Background = background;

PopulateTrueColorsFromConsoleColors ();
}

/// <summary>
/// Initializes a new instance of the <see cref="Attribute"/> struct.
/// Initializes a new instance of the <see cref="Attribute"/> class.
/// </summary>
/// <param name="value">Value.</param>
/// <param name="foreground">Foreground</param>
Expand All @@ -212,10 +223,12 @@ public Attribute (int value, Color foreground, Color background)
Value = value;
Foreground = foreground;
Background = background;

PopulateTrueColorsFromConsoleColors ();
}

/// <summary>
/// Initializes a new instance of the <see cref="Attribute"/> struct.
/// Initializes a new instance of the <see cref="Attribute"/> class.
/// </summary>
/// <param name="foreground">Foreground</param>
/// <param name="background">Background</param>
Expand All @@ -224,15 +237,55 @@ public Attribute (Color foreground, Color background)
Value = Make (foreground, background).Value;
Foreground = foreground;
Background = background;

PopulateTrueColorsFromConsoleColors ();
}

/// <summary>
/// Initializes a new instance of the <see cref="Attribute"/> struct
/// Initializes a new instance of the <see cref="Attribute"/> class
/// with the same colors for the foreground and background.
/// </summary>
/// <param name="color">The color.</param>
public Attribute (Color color) : this (color, color) { }

/// <summary>
/// Initializes a new instance of the <see cref="Attribute"/> class. Populates
/// <see cref="TrueColorBackground"/> and <see cref="TrueColorForeground"/>. Also computes
/// <see cref="Foreground"/> and <see cref="Background"/> (basic console colors) in case
/// driver does not support true color rendering.
/// </summary>
/// <param name="trueColorForeground"></param>
/// <param name="trueColorBackground"></param>
public Attribute (TrueColor trueColorForeground, TrueColor trueColorBackground)
{
TrueColorForeground = trueColorForeground;
TrueColorBackground = trueColorBackground;

PopulateConsoleColorsFromTrueColors ();
}


/// <summary>
/// <para>
/// Initializes a new instance of the <see cref="Attribute"/> class. Populates
/// <see cref="TrueColorBackground"/> and <see cref="TrueColorForeground"/> with explicit
/// fallback values for <see cref="Foreground"/> and <see cref="Background"/> (in case
/// driver does not support true color rendering).
/// </para>
/// <remarks>If you do not want to manually specify the fallback colors use <see cref="Attribute(TrueColor,TrueColor)"/>
/// instead which auto calculates these.</remarks>
/// </summary>
/// <param name="trueColorForeground">True color RGB values you would like to use.</param>
/// <param name="trueColorBackground">True color RGB values you would like to use.</param>
/// <param name="foreground">Simple console color replacement if driver does not support true color.</param>
/// <param name="background">Simple console color replacement if driver does not support true color.</param>
public Attribute (TrueColor trueColorForeground, TrueColor trueColorBackground, Color foreground, Color background)
: this (foreground, background)
{
TrueColorForeground = trueColorForeground;
TrueColorBackground = trueColorBackground;
}

/// <inheritdoc/>
public bool Equals (Attribute other)
{
Expand Down Expand Up @@ -281,39 +334,94 @@ public static Attribute Get ()
/// Default empty attribute.
/// </summary>
public static readonly Attribute Default = new Attribute ();
}

/// <summary>
/// Defines a true color attribute.
/// </summary>
public class TrueColorAttribute : Attribute {
/// <summary>
/// Initializes a new instance of the <see cref="TrueColorAttribute"/> struct.
/// Populates <see cref="TrueColorForeground"/> and <see cref="TrueColorBackground"/> based on
/// <see cref="Foreground"/> and <see cref="Background"/> console colors.
/// </summary>
/// <param name="foreground">Foreground</param>
/// <param name="background">Background</param>
public TrueColorAttribute (TrueColor foreground, TrueColor background)
: base ((Color)TrueColor.GetCode4 (foreground), (Color)TrueColor.GetCode4 (background))
private void PopulateTrueColorsFromConsoleColors ()
{
TrueColorForeground = foreground;
TrueColorBackground = background;
TrueColorForeground = ConsoleColorToTrueColor (Foreground);
TrueColorBackground = ConsoleColorToTrueColor (Background);
}

/// <summary>
/// Initializes a new instance of the <see cref="TrueColorAttribute"/> struct
/// with the same colors for the foreground and background.
/// </summary>
/// <param name="color">The color.</param>
public TrueColorAttribute (TrueColor color) : this (color, color) { }
private TrueColor ConsoleColorToTrueColor (Color consoleColor)
{
// Brown in cmd is
// C1 9C 00

switch (consoleColor) {
case Color.Black: return new TrueColor (0, 0, 0);
case Color.Blue: return new TrueColor (0, 0, 0x80);
case Color.Green: return new TrueColor (0, 0x80, 0);
case Color.Cyan: return new TrueColor (0, 0x80, 0x80);
case Color.Red: return new TrueColor (0x80, 0, 0);
case Color.Magenta: return new TrueColor (0x80, 0, 0x80);
case Color.Brown: return new TrueColor (0xC1, 0x9C, 0x00); // TODO confirm this
case Color.Gray: return new TrueColor (0xC0, 0xC0, 0xC0);
case Color.DarkGray: return new TrueColor (0x80, 0x80, 0x80);
case Color.BrightBlue: return new TrueColor (0, 0, 0xFF);
case Color.BrightGreen: return new TrueColor (0, 0xFF, 0);
case Color.BrightCyan: return new TrueColor (0, 0xFF, 0xFF);
case Color.BrightRed: return new TrueColor (0xFF, 0, 0);
case Color.BrightMagenta: return new TrueColor (0xFF, 0, 0xFF);
case Color.BrightYellow: return new TrueColor (0xFF, 0xFF, 0);
case Color.White: return new TrueColor (0xFF, 0xFF, 0xFF);
default: throw new ArgumentOutOfRangeException (nameof (consoleColor));
};
}

/// <summary>
/// The foreground color.
/// </summary>
public TrueColor TrueColorForeground { get; }
/// <summary>
/// The background color.
/// </summary>
public TrueColor TrueColorBackground { get; }
private void PopulateConsoleColorsFromTrueColors ()
{
Foreground = TrueColorToConsoleColor (TrueColorForeground);
Background = TrueColorToConsoleColor (TrueColorBackground);
Value = Make (Foreground, Background).Value;
}

private Color TrueColorToConsoleColor (TrueColor trueColor)
{
// The points we could return from
var lookup = new Dictionary<TrueColor, Color> () {
{ new TrueColor(0,0,0),Color.Black},
{ new TrueColor (0, 0, 0x80),Color.Blue},
{ new TrueColor (0, 0x80, 0),Color.Green},
{ new TrueColor (0, 0x80, 0x80),Color.Cyan},
{ new TrueColor (0x80, 0, 0),Color.Red},
{ new TrueColor (0x80, 0, 0x80),Color.Magenta},
{ new TrueColor (0xC1, 0x9C, 0x00),Color.Brown}, // TODO confirm this
{ new TrueColor (0xC0, 0xC0, 0xC0),Color.Gray},
{ new TrueColor (0x80, 0x80, 0x80),Color.DarkGray},
{ new TrueColor (0, 0, 0xFF),Color.BrightBlue},
{ new TrueColor (0, 0xFF, 0),Color.BrightGreen},
{ new TrueColor (0, 0xFF, 0xFF),Color.BrightCyan},
{ new TrueColor (0xFF, 0, 0),Color.BrightRed},
{ new TrueColor (0xFF, 0, 0xFF),Color.BrightMagenta },
{ new TrueColor (0xFF, 0xFF, 0),Color.BrightYellow},
{ new TrueColor (0xFF, 0xFF, 0xFF),Color.White},
};

var distances = lookup.Select (
k => Tuple.Create (
// the candidate we are considering matching against (RGB)
k.Key,

CalculateDistance (k.Key, trueColor)
));

// get the closest
var match = distances.OrderBy (t => t.Item2).First ();

return lookup [match.Item1];
}

private float CalculateDistance (TrueColor color1, TrueColor color2)
{
// use RGB distance
return
Math.Abs (color1.Red - color2.Red) +
Math.Abs (color1.Green - color2.Green) +
Math.Abs (color1.Blue - color2.Blue);
}
}

/// <summary>
Expand Down
Loading