diff --git a/Source/Meadow.Contracts/Color.cs b/Source/Meadow.Contracts/Color.cs index 8a243566..d905b565 100644 --- a/Source/Meadow.Contracts/Color.cs +++ b/Source/Meadow.Contracts/Color.cs @@ -1,848 +1,842 @@ using System; -namespace Meadow +namespace Meadow; + +/// +/// 32bit color struct +/// +public struct Color { /// - /// 32bit color struct + /// Default color - black with 0 alpha /// - public struct Color - { - /// - /// Default color - black with 0 alpha - /// - public static Color Default - { - get { return new Color(0, 0, 0, 0); } - } + public static Color Default => new(0, 0, 0, 0); - /// - /// Get the 4bpp grayscale value for current color - /// - public readonly byte Color4bppGray => (byte)((byte)(0.2989 * R + 0.5870 * G + 0.114 * B) >> 4); - - /// - /// Get the 8bpp grayscale value for current color - /// - public readonly byte Color8bppGray => (byte)(0.2989 * R + 0.5870 * G + 0.114 * B); - - /// - /// Get the 8bpp (332) color value for current color - /// - public readonly byte Color8bppRgb332 => (byte)((R & 0b11100000) | (G & 0b1110000) >> 3 | ((B & 0b11000000) >> 6)); - - /// - /// Get the 12bpp (444) color value for current color - /// - public readonly ushort Color12bppRgb444 => - (ushort)(((R & 0b11110000) << 4) | (G & 0b11110000) | ((B & 0b11110000) >> 4)); - - /// - /// Get the 16bpp (565) color value for current color - /// - public readonly ushort Color16bppRgb565 => - (ushort)(((R & 0b11111000) << 8) | ((G & 0b11111100) << 3) | (B >> 3)); - - /// - /// Get the 1bpp (on or off) value for current color - /// - public readonly bool Color1bpp => R > 0 || G > 0 || B > 0; - - /// - /// Current alpha value (0-255) - /// - public byte A { get; private set; } - - /// - /// Current red value (0-255) - /// - public byte R { get; private set; } - - /// - /// Current green value (0-255) - /// - public byte G { get; private set; } - - /// - /// Current blue value (0-255) - /// - public byte B { get; private set; } - - /// - /// Hue of current color (0-360.0) - /// - public float Hue + /// + /// Get the 4bpp grayscale value for current color + /// + public readonly byte Color4bppGray => (byte)((0.2989 * R + 0.5870 * G + 0.114 * B) / 16); + + /// + /// Get the 8bpp grayscale value for current color + /// + public readonly byte Color8bppGray => (byte)(0.2989 * R + 0.5870 * G + 0.114 * B); + + /// + /// Get the 8bpp (332) color value for current color + /// + public readonly byte Color8bppRgb332 => (byte)((R & 0b11100000) | ((G & 0b11100000) >> 3) | ((B & 0b11000000) >> 6)); + + /// + /// Get the 12bpp (444) color value for current color + /// + public readonly ushort Color12bppRgb444 => (ushort)(((R & 0b11110000) << 4) | (G & 0b11110000) | ((B & 0b11110000) >> 4)); + + /// + /// Get the 16bpp (565) color value for current color + /// + public readonly ushort Color16bppRgb565 => (ushort)(((R & 0b11111000) << 8) | ((G & 0b11111100) << 3) | (B >> 3)); + + /// + /// Get the 1bpp (on or off) value for current color + /// + public readonly bool Color1bpp => R > 0 || G > 0 || B > 0; + + /// + /// Current alpha value (0-255) + /// + public byte A { get; private set; } + + /// + /// Current red value (0-255) + /// + public byte R { get; private set; } + + /// + /// Current green value (0-255) + /// + public byte G { get; private set; } + + /// + /// Current blue value (0-255) + /// + public byte B { get; private set; } + + private float hue; + private float saturation; + private float brightness; + + /// + /// Hue of current color (0-360.0) + /// + public float Hue + { + get { - get + if (hue == -1) { - if (hue == -1) - { - ConvertToHsb(R, G, B, out hue, out saturation, out brightness); - } - return hue; + ConvertToHsb(R, G, B, out hue, out saturation, out brightness); } + return hue; } - float hue; + } - /// - /// Saturation of color (0-1.0) - /// - public float Saturation + /// + /// Saturation of color (0-1.0) + /// + public float Saturation + { + get { - get + if (saturation == -1) { - if (saturation == -1) - { - ConvertToHsb(R, G, B, out hue, out saturation, out brightness); - } - return saturation; + ConvertToHsb(R, G, B, out hue, out saturation, out brightness); } + return saturation; } - float saturation; + } - /// - /// Brightness of color (0-1.0) - /// - public float Brightness + /// + /// Brightness of color (0-1.0) + /// + public float Brightness + { + get { - get + if (brightness == -1) { - if (brightness == -1) - { - ConvertToHsb(R, G, B, out hue, out saturation, out brightness); - } - return brightness; + ConvertToHsb(R, G, B, out hue, out saturation, out brightness); } + return brightness; } - float brightness; - - /// - /// Create a color struct - /// - /// red component of color - /// green component of color - /// blue component of color - /// transparency of color - public Color(byte red, byte green, byte blue, byte alpha = 255) - { - R = red; - G = green; - B = blue; - A = alpha; - - hue = saturation = brightness = -1; - } - - /// - /// Create a color struct - convenience ctor for floats - prefer byte version - /// - /// red component of color - /// green component of color - /// blue component of color - public Color(float red, float green, float blue) : - this((byte)(red * 255), (byte)(green * 255), (byte)(blue * 255), 1) - { - } - - /// - /// Create a color struct - /// - /// hue of color - /// saturation of color - /// brightness of color - /// alpha (transparency) of color - - public Color(float hue, float saturation, float brightness, byte alpha = 255) - { - HslToRgb(hue * 360, saturation, brightness, out float red, out float green, out float blue); + } - R = (byte)(255 * red); - G = (byte)(255 * green); - B = (byte)(255 * blue); - A = alpha; + /// + /// Create a color struct + /// + /// red component of color + /// green component of color + /// blue component of color + /// transparency of color + public Color(byte red, byte green, byte blue, byte alpha = 255) + { + R = red; + G = green; + B = blue; + A = alpha; - this.hue = hue; - this.saturation = saturation; - this.brightness = brightness; - } + hue = saturation = brightness = -1; + } - /// - /// Create a new color struct from current color with new brightness - /// - /// brightness of new color (0-1.0) - /// new color object - public Color WithBrightness(float brightness) - { - return new Color(Hue, Saturation, brightness, A); - } + /// + /// Create a color struct - convenience ctor for floats - prefer byte version + /// + /// red component of color + /// green component of color + /// blue component of color + public Color(float red, float green, float blue) : + this((byte)(red * 255), (byte)(green * 255), (byte)(blue * 255), 255) + { + } - /// - /// Create a new color struct from current color with new hue - /// - /// hue of new color (0-360.0) - /// new color object - public Color WithHue(float hue) - { - return new Color(hue, Saturation, Brightness, A); - } + /// + /// Create a color struct + /// + /// hue of color + /// saturation of color + /// brightness of color + /// alpha (transparency) of color + public Color(float hue, float saturation, float brightness, byte alpha = 255) + { + HslToRgb(hue * 360, saturation, brightness, out float red, out float green, out float blue); - /// - /// Create a new color structs from current color with new saturation - /// - /// saturation of new color (0-1.0) - /// new color object - public Color WithSaturation(float saturation) - { - return new Color(Hue, saturation, Brightness, A); - } + R = (byte)(255 * red); + G = (byte)(255 * green); + B = (byte)(255 * blue); + A = alpha; - static void ConvertToHsb(byte r, byte g, byte b, out float h, out float s, out float l) - { - ConvertToHsb(r / 255.0f, g / 255.0f, b / 255.0f, out h, out s, out l); - } + this.hue = hue; + this.saturation = saturation; + this.brightness = brightness; + } - static void ConvertToHsb(float r, float g, float b, out float h, out float s, out float l) - { - float v = Math.Max(r, g); - v = Math.Max(v, b); + /// + /// Create a new color struct from current color with new brightness + /// + /// brightness of new color (0-1.0) + /// new color object + public Color WithBrightness(float brightness) + { + return new Color(Hue, Saturation, brightness, A); + } - float m = Math.Min(r, g); - m = Math.Min(m, b); + /// + /// Create a new color struct from current color with new hue + /// + /// hue of new color (0-360.0) + /// new color object + public Color WithHue(float hue) + { + return new Color(hue, Saturation, Brightness, A); + } - l = (m + v) / 2.0f; - if (l <= 0.0) - { - h = s = l = 0; - return; - } - float vm = v - m; - s = vm; + /// + /// Create a new color structs from current color with new saturation + /// + /// saturation of new color (0-1.0) + /// new color object + public Color WithSaturation(float saturation) + { + return new Color(Hue, saturation, Brightness, A); + } - if (s > 0.0) - { - s /= l <= 0.5f ? v + m : 2.0f - v - m; - } - else - { - h = 0; - s = 0; - return; - } + static void ConvertToHsb(byte r, byte g, byte b, out float h, out float s, out float l) + { + ConvertToHsb(r / 255.0f, g / 255.0f, b / 255.0f, out h, out s, out l); + } - float r2 = (v - r) / vm; - float g2 = (v - g) / vm; - float b2 = (v - b) / vm; + static void ConvertToHsb(float r, float g, float b, out float h, out float s, out float l) + { + float v = Math.Max(r, g); + v = Math.Max(v, b); - if (r == v) - { - h = g == m ? 5.0f + b2 : 1.0f - g2; - } - else if (g == v) - { - h = b == m ? 1.0f + r2 : 3.0f - b2; - } - else - { - h = r == m ? 3.0f + g2 : 5.0f - r2; - } - h /= 6.0f; - } + float m = Math.Min(r, g); + m = Math.Min(m, b); - /// - /// Equality operator - /// - /// left color value - /// right color value - /// true if equal - public static bool operator ==(Color color1, Color color2) + l = (m + v) / 2.0f; + if (l <= 0.0) { - return EqualsInner(color1, color2); + h = s = l = 0; + return; } + float vm = v - m; + s = vm; - /// - /// Not equals operator - /// - /// left color value - /// right color value - /// true if not equals - public static bool operator !=(Color color1, Color color2) + if (s > 0.0) { - return !EqualsInner(color1, color2); + s /= l <= 0.5f ? v + m : 2.0f - v - m; } - - /// - /// Get hash of color - /// - /// hash as 32bit int - public override readonly int GetHashCode() + else { - return HashCode.Combine(R, G, B, A); + h = 0; + s = 0; + return; } - /// - /// Compare two color structs for equality - /// - /// - /// true if equals - public override readonly bool Equals(object obj) - { - if (obj is Color color) - { - return EqualsInner(this, color); - } - return base.Equals(obj); - } + float r2 = (v - r) / vm; + float g2 = (v - g) / vm; + float b2 = (v - b) / vm; - /// - /// Compare two color structs for equality - /// - /// - /// true if equals - public readonly bool Equals(Color other) + if (r == v) { - return EqualsInner(this, other); + h = g == m ? 5.0f + b2 : 1.0f - g2; } - - static bool EqualsInner(Color color1, Color color2) + else if (g == v) { - return color1.R == color2.R && color1.G == color2.G && color1.B == color2.B && color1.A == color2.A; + h = b == m ? 1.0f + r2 : 3.0f - b2; } - - /// - /// Convert color to string - /// - /// string representing color - public override string ToString() + else { - return "[Color: A={" + A + "}, R={" + R + "}, G={" + G + "}, B={" + B + "}, Hue={" + Hue + "}, Saturation={" + Saturation + "}, Brightness={" + Brightness + "}]"; + h = r == m ? 3.0f + g2 : 5.0f - r2; } + h /= 6.0f; + } - static uint ToHex(char c) - { - ushort x = c; - if (x >= '0' && x <= '9') - { - return (uint)(x - '0'); - } + /// + /// Equality operator + /// + /// left color value + /// right color value + /// true if equal + public static bool operator ==(Color color1, Color color2) + { + return EqualsInner(color1, color2); + } - x |= 0x20; - if (x >= 'a' && x <= 'f') - { - return (uint)(x - 'a' + 10); - } - return 0; - } + /// + /// Not equals operator + /// + /// left color value + /// right color value + /// true if not equals + public static bool operator !=(Color color1, Color color2) + { + return !EqualsInner(color1, color2); + } - static uint ToHexD(char c) + /// + /// Get hash of color + /// + /// hash as 32bit int + public override readonly int GetHashCode() + { + return HashCode.Combine(R, G, B, A); + } + + /// + /// Compare two color structs for equality + /// + /// + /// true if equals + public override readonly bool Equals(object obj) + { + if (obj is Color color) { - var j = ToHex(c); - return (j << 4) | j; + return EqualsInner(this, color); } + return base.Equals(obj); + } - /// - /// Create a color object from a hex string - /// - /// string hex value - /// new color object - public static Color FromHex(string hex) - { - // Undefined - if (hex.Length < 3) - { - return Default; - } - int idx = (hex[0] == '#') ? 1 : 0; + /// + /// Compare two color structs for equality + /// + /// + /// true if equals + public readonly bool Equals(Color other) + { + return EqualsInner(this, other); + } - switch (hex.Length - idx) - { - case 3: //#rgb => ffrrggbb - var t1 = ToHexD(hex[idx++]); - var t2 = ToHexD(hex[idx++]); - var t3 = ToHexD(hex[idx]); - - return FromRgb((byte)t1, (byte)t2, (byte)t3); - - case 4: //#argb => aarrggbb - var f1 = ToHexD(hex[idx++]); - var f2 = ToHexD(hex[idx++]); - var f3 = ToHexD(hex[idx++]); - var f4 = ToHexD(hex[idx]); - return FromRgba((byte)f2, (byte)f3, (byte)f4, (byte)f1); - - case 6: //#rrggbb => ffrrggbb - return FromRgb((byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), - (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), - (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx]))); - - case 8: //#aarrggbb - var a1 = ToHex(hex[idx++]) << 4 | ToHex(hex[idx++]); - return FromRgba((byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), - (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), - (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx])), - (byte)a1); - - default: //everything else will result in unexpected results - return Default; - } - } + static bool EqualsInner(Color color1, Color color2) + { + return color1.R == color2.R && color1.G == color2.G && color1.B == color2.B && color1.A == color2.A; + } + + /// + /// Convert color to string + /// + /// string representing color + public override string ToString() + { + return "[Color: A={" + A + "}, R={" + R + "}, G={" + G + "}, B={" + B + "}, Hue={" + Hue + "}, Saturation={" + Saturation + "}, Brightness={" + Brightness + "}]"; + } - /// - /// Create a color object from a 32bit unsigned int - /// - /// color value - 8 bits red, 8 bits green, 8 bits blue, 8 bits alpha - /// new color object - public static Color FromUint(uint argb) + static uint ToHex(char c) + { + ushort x = c; + if (x >= '0' && x <= '9') { - return FromRgba((byte)((argb & 0x00ff0000) >> 0x10), (byte)((argb & 0x0000ff00) >> 0x8), (byte)(argb & 0x000000ff), (byte)((argb & 0xff000000) >> 0x18)); + return (uint)(x - '0'); } - /// - /// Create a new color object - /// - /// red component of color (0-255) - /// green component of color (0-255) - /// blue component of color (0-255) - /// alpha of color (0-255) - /// new color object - public static Color FromRgba(byte r, byte g, byte b, byte a) + x |= 0x20; + if (x >= 'a' && x <= 'f') { - return new Color(r, g, b, a); + return (uint)(x - 'a' + 10); } - /// - /// Create a new color object - /// - /// red component of color (0-255) - /// green component of color (0-255) - /// blue component of color (0-255) - - public static Color FromRgb(byte r, byte g, byte b) + return 0; + } + + static uint ToHexD(char c) + { + var j = ToHex(c); + return (j << 4) | j; + } + + /// + /// Create a color object from a hex string + /// + /// string hex value + /// new color object + public static Color FromHex(string hex) + { + // Undefined + if (hex.Length < 3) { - return FromRgba(r, g, b, 255); + return Default; } + int idx = (hex[0] == '#') ? 1 : 0; - /// - /// Create a new color object - /// - /// red component of color (0-1) - /// green component of color (0-1) - /// blue component of color (0-1) - /// alpha of color (0-1) - /// new color object - public static Color FromRgba(float r, float g, float b, float a) + switch (hex.Length - idx) { - return new Color((byte)(r * 255), (byte)(g * 255), (byte)(b * 255), (byte)(a * 255)); + case 3: //#rgb => ffrrggbb + var t1 = ToHexD(hex[idx++]); + var t2 = ToHexD(hex[idx++]); + var t3 = ToHexD(hex[idx]); + + return FromRgb((byte)t1, (byte)t2, (byte)t3); + + case 4: //#argb => aarrggbb + var f1 = ToHexD(hex[idx++]); + var f2 = ToHexD(hex[idx++]); + var f3 = ToHexD(hex[idx++]); + var f4 = ToHexD(hex[idx]); + return FromRgba((byte)f2, (byte)f3, (byte)f4, (byte)f1); + + case 6: //#rrggbb => ffrrggbb + return FromRgb((byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), + (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), + (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx]))); + + case 8: //#aarrggbb + var a1 = ToHex(hex[idx++]) << 4 | ToHex(hex[idx++]); + return FromRgba((byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), + (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx++])), + (byte)(ToHex(hex[idx++]) << 4 | ToHex(hex[idx])), + (byte)a1); + + default: //everything else will result in unexpected results + return Default; } + } + + /// + /// Create a color object from a 32bit unsigned int + /// + /// color value - 8 bits red, 8 bits green, 8 bits blue, 8 bits alpha + /// new color object + public static Color FromUint(uint argb) + { + return FromRgba((byte)((argb & 0x00ff0000) >> 0x10), (byte)((argb & 0x0000ff00) >> 0x8), (byte)(argb & 0x000000ff), (byte)((argb & 0xff000000) >> 0x18)); + } + + /// + /// Create a new color object + /// + /// red component of color (0-255) + /// green component of color (0-255) + /// blue component of color (0-255) + /// alpha of color (0-255) + /// new color object + public static Color FromRgba(byte r, byte g, byte b, byte a) + { + return new Color(r, g, b, a); + } + + /// + /// Create a new color object + /// + /// red component of color (0-255) + /// green component of color (0-255) + /// blue component of color (0-255) + public static Color FromRgb(byte r, byte g, byte b) + { + return FromRgba(r, g, b, 255); + } + + /// + /// Create a new color object + /// + /// red component of color (0-1) + /// green component of color (0-1) + /// blue component of color (0-1) + /// alpha of color (0-1) + /// new color object + public static Color FromRgba(float r, float g, float b, float a) + { + return new Color((byte)(r * 255), (byte)(g * 255), (byte)(b * 255), (byte)(a * 255)); + } + + /// + /// Create a new color object + /// + /// red component of color (0-1) + /// green component of color (0-1) + /// blue component of color (0-1) + /// new color object + public static Color FromRgb(float r, float g, float b) + { + return FromRgba(r, g, b, 1f); + } + + /// + /// Create a new color object + /// + /// hue of color (0-360) + /// saturation of color (0-1) + /// brightness of color (0-1) + /// alpha of color (0-1) + /// new color object + public static Color FromHsba(float h, float s, float b, float a = 1.0f) + { + return new Color(h, s, b, (byte)(a * 255)); + } + + /// + /// Takes Hue, Saturation and Value and returns a Color object + /// + /// + /// + /// + /// + /// A Color object + public static Color FromAhsv(float alpha, float hue, float saturation, float value) + { + HsvToRgb(hue, saturation, value, out float red, out float green, out float blue); + + return new Color((byte)(red * 255), (byte)(green * 255), (byte)(blue * 255), (byte)(alpha * 255)); + } + + /// + /// HSL to RGB + /// + /// Hue in degrees (0-359°) + /// Saturation + /// Brightness value + /// The red component (0-1) + /// The green component (0-1) + /// The blue component (0-1) + public static void HslToRgb(float hue, float saturation, float lightness, out float r, out float g, out float b) + { + float h = hue; + float R, G, B; - /// - /// Create a new color object - /// - /// red component of color (0-1) - /// green component of color (0-1) - /// blue component of color (0-1) - /// new color object - public static Color FromRgb(float r, float g, float b) + // hue parameter checking/fixing + if (h < 0) { - return FromRgba(r, g, b, 1f); + h = 0; } - - /// - /// Create a new color object - /// - /// hue of color (0-360) - /// saturation of color (0-1) - /// brightness of color (0-1) - /// alpha of color (0-1) - /// new color object - public static Color FromHsba(float h, float s, float b, float a = 1.0f) + else if (h >= 360) { - return new Color(h, s, b, (byte)(a * 255)); + h %= 360; } - /// - /// Takes Hue, Saturation and Value and returns a Color object - /// - /// - /// - /// - /// - /// A Color object - public static Color FromAhsv(float alpha, float hue, float saturation, float value) - { - HsvToRgb(hue, saturation, value, out float red, out float green, out float blue); + //default to gray + R = G = B = lightness; - return new Color((byte)(red * 255), (byte)(green * 255), (byte)(blue * 255), (byte)(alpha * 255)); - } + var v = (lightness <= 0.5f) ? + (lightness * (1.0f + saturation)) : + (lightness + saturation - lightness * saturation); - /// - /// HSL to RGB - /// - /// Hue in degrees (0-359°) - /// Saturation - /// Brightness value - /// The red component (0-1) - /// The green component (0-1) - /// The blue component (0-1) - public static void HslToRgb(float hue, float saturation, float lightness, out float r, out float g, out float b) + if (v > 0) { - float h = hue; - float R, G, B; + float m; + float l = lightness; + float sv; + int sextant; + float fract, vsf, mid1, mid2; - // hue parameter checking/fixing - if (h < 0) - { - h = 0; - } - else if (h >= 360) + m = l + l - v; + sv = (v - m) / v; + h /= 60.0f; + sextant = (int)h; + fract = h - sextant; + vsf = v * sv * fract; + mid1 = m + vsf; + mid2 = v - vsf; + switch (sextant) { - h %= 360; + case 0: + R = v; + G = mid1; + B = m; + break; + case 1: + R = mid2; + G = v; + B = m; + break; + case 2: + R = m; + G = v; + B = mid1; + break; + case 3: + R = m; + G = mid2; + B = v; + break; + case 4: + R = mid1; + G = m; + B = v; + break; + case 5: + R = v; + G = m; + B = mid2; + break; } + } - //default to gray - R = G = B = lightness; - - var v = (lightness <= 0.5f) ? - (lightness * (1.0f + saturation)) : - (lightness + saturation - lightness * saturation); + r = Clamp(R); + g = Clamp(G); + b = Clamp(B); + } - if (v > 0) - { - float m; - float l = lightness; - float sv; - int sextant; - float fract, vsf, mid1, mid2; - - m = l + l - v; - sv = (v - m) / v; - h /= 60.0f; - sextant = (int)h; - fract = h - sextant; - vsf = v * sv * fract; - mid1 = m + vsf; - mid2 = v - vsf; - switch (sextant) - { - case 0: - R = v; - G = mid1; - B = m; - break; - case 1: - R = mid2; - G = v; - B = m; - break; - case 2: - R = m; - G = v; - B = mid1; - break; - case 3: - R = m; - G = mid2; - B = v; - break; - case 4: - R = mid1; - G = m; - B = v; - break; - case 5: - R = v; - G = m; - B = mid2; - break; - } - } + /// + /// HSV to RGB + /// + /// Hue in degrees (0-359°) + /// Saturation + /// Brightness value + /// The red component (0-1) + /// The green component (0-1) + /// The blue component (0-1) + public static void HsvToRgb(float hue, float saturation, float brightValue, out float r, out float g, out float b) + { + float H = hue; + float R, G, B; - r = Clamp(R); - g = Clamp(G); - b = Clamp(B); + // hue parameter checking/fixing + if (H < 0) + { + H = 0; + } + else if (H > 360) + { + H %= 360; } - /// - /// HSV to RGB - /// - /// Hue in degrees (0-359°) - /// Saturation - /// Brightness value - /// The red component (0-1) - /// The green component (0-1) - /// The blue component (0-1) - public static void HsvToRgb(float hue, float saturation, float brightValue, out float r, out float g, out float b) + // if Brightness is turned off, then everything is zero. + if (brightValue <= 0) { - float H = hue; - float R, G, B; + R = G = B = 0; + } - // hue parameter checking/fixing - if (H < 0) - { - H = 0; - } - else if (H > 360) - { - H %= 360; - } + // if saturation is turned off, then there is no color/hue. it's grayscale. + else if (saturation <= 0) + { + R = G = B = brightValue; + } + else // if we got here, then there is a color to create. + { + float hf = H / 60.0f; + int i = (int)Math.Floor(hf); + float f = hf - i; + float pv = brightValue * (1 - saturation); + float qv = brightValue * (1 - saturation * f); + float tv = brightValue * (1 - saturation * (1 - f)); - // if Brightness is turned off, then everything is zero. - if (brightValue <= 0) + switch (i) { - R = G = B = 0; - } - // if saturation is turned off, then there is no color/hue. it's grayscale. - else if (saturation <= 0) - { - R = G = B = brightValue; + // Red Dominant + case 0: + R = brightValue; + G = tv; + B = pv; + break; + + // Green Dominant + case 1: + R = qv; + G = brightValue; + B = pv; + break; + case 2: + R = pv; + G = brightValue; + B = tv; + break; + + // Blue Dominant + case 3: + R = pv; + G = qv; + B = brightValue; + break; + case 4: + R = tv; + G = pv; + B = brightValue; + break; + + // Red Red Dominant + case 5: + R = brightValue; + G = pv; + B = qv; + break; + + // In case the math is out of bounds, this is a fix. + case 6: + R = brightValue; + G = tv; + B = pv; + break; + case -1: + R = brightValue; + G = pv; + B = qv; + break; + + // If the color is not defined, go grayscale + default: + R = G = B = brightValue; + break; } - else // if we got here, then there is a color to create. - { - float hf = H / 60.0f; - int i = (int)Math.Floor(hf); - float f = hf - i; - float pv = brightValue * (1 - saturation); - float qv = brightValue * (1 - saturation * f); - float tv = brightValue * (1 - saturation * (1 - f)); - - switch (i) - { - - // Red Dominant - case 0: - R = brightValue; - G = tv; - B = pv; - break; - - // Green Dominant - case 1: - R = qv; - G = brightValue; - B = pv; - break; - case 2: - R = pv; - G = brightValue; - B = tv; - break; - - // Blue Dominant - case 3: - R = pv; - G = qv; - B = brightValue; - break; - case 4: - R = tv; - G = pv; - B = brightValue; - break; - - // Red Red Dominant - case 5: - R = brightValue; - G = pv; - B = qv; - break; - - // In case the math is out of bounds, this is a fix. - case 6: - R = brightValue; - G = tv; - B = pv; - break; - case -1: - R = brightValue; - G = pv; - B = qv; - break; - - // If the color is not defined, go grayscale - default: - R = G = B = brightValue; - break; - } - } - r = Clamp(R); - g = Clamp(G); - b = Clamp(B); } + r = Clamp(R); + g = Clamp(G); + b = Clamp(B); + } + + /// + /// Clamp a value to 0 to 1 + /// + static float Clamp(float i) + { + if (i < 0) return 0; + if (i > 1) return 1; + return i; + } - /// - /// Clamp a value to 0 to 1 - /// - static float Clamp(float i) + /// + /// Blend a new color with the current color + /// + /// The color to blend + /// The ratio of the blend color to source color + /// The resulting blended color + public Color Blend(Color blendColor, float ratio) + { + if (ratio == 0) { - if (i < 0) return 0; - if (i > 1) return 1; - return i; + return this; } - - /// - /// Blend a new color with the current color - /// - /// The color to blend - /// The ratio of the blend color to source color - /// The resulting blended color - public Color Blend(Color blendColor, float ratio) + if (ratio == 1) { - if (ratio == 0) - { - return this; - } - if (ratio == 1) - { - return blendColor; - } - - byte r = (byte)(R * (1 - ratio) + blendColor.R * ratio); - byte g = (byte)(G * (1 - ratio) + blendColor.G * ratio); - byte b = (byte)(B * (1 - ratio) + blendColor.B * ratio); - return Color.FromRgb(r, g, b); + return blendColor; } - // matches colors in WPF's System.Windows.Media.Colors + byte r = (byte)(R * (1 - ratio) + blendColor.R * ratio); + byte g = (byte)(G * (1 - ratio) + blendColor.G * ratio); + byte b = (byte)(B * (1 - ratio) + blendColor.B * ratio); + return Color.FromRgb(r, g, b); + } + + // matches colors in WPF's System.Windows.Media.Colors #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member - public static readonly Color AliceBlue = FromRgb(240, 248, 255); - public static readonly Color AntiqueWhite = FromRgb(250, 235, 215); - public static readonly Color Aqua = FromRgb(0, 255, 255); - public static readonly Color Aquamarine = FromRgb(127, 255, 212); - public static readonly Color Azure = FromRgb(240, 255, 255); - public static readonly Color Beige = FromRgb(245, 245, 220); - public static readonly Color Bisque = FromRgb(255, 228, 196); - public static readonly Color Black = FromRgb(0, 0, 0); - public static readonly Color BlanchedAlmond = FromRgb(255, 235, 205); - public static readonly Color Blue = FromRgb(0, 0, 255); - public static readonly Color BlueViolet = FromRgb(138, 43, 226); - public static readonly Color Brown = FromRgb(165, 42, 42); - public static readonly Color BurlyWood = FromRgb(222, 184, 135); - public static readonly Color CadetBlue = FromRgb(95, 158, 160); - public static readonly Color Chartreuse = FromRgb(127, 255, 0); - public static readonly Color Chocolate = FromRgb(210, 105, 30); - public static readonly Color Coral = FromRgb(255, 127, 80); - public static readonly Color CornflowerBlue = FromRgb(100, 149, 237); - public static readonly Color Cornsilk = FromRgb(255, 248, 220); - public static readonly Color Crimson = FromRgb(220, 20, 60); - public static readonly Color Cyan = FromRgb(0, 255, 255); - public static readonly Color DarkBlue = FromRgb(0, 0, 139); - public static readonly Color DarkCyan = FromRgb(0, 139, 139); - public static readonly Color DarkGoldenrod = FromRgb(184, 134, 11); - public static readonly Color DarkGray = FromRgb(169, 169, 169); - public static readonly Color DarkGreen = FromRgb(0, 100, 0); - public static readonly Color DarkKhaki = FromRgb(189, 183, 107); - public static readonly Color DarkMagenta = FromRgb(139, 0, 139); - public static readonly Color DarkOliveGreen = FromRgb(85, 107, 47); - public static readonly Color DarkOrange = FromRgb(255, 140, 0); - public static readonly Color DarkOrchid = FromRgb(153, 50, 204); - public static readonly Color DarkRed = FromRgb(139, 0, 0); - public static readonly Color DarkSalmon = FromRgb(233, 150, 122); - public static readonly Color DarkSeaGreen = FromRgb(143, 188, 143); - public static readonly Color DarkSlateBlue = FromRgb(72, 61, 139); - public static readonly Color DarkSlateGray = FromRgb(47, 79, 79); - public static readonly Color DarkTurquoise = FromRgb(0, 206, 209); - public static readonly Color DarkViolet = FromRgb(148, 0, 211); - public static readonly Color DeepPink = FromRgb(255, 20, 147); - public static readonly Color DeepSkyBlue = FromRgb(0, 191, 255); - public static readonly Color DimGray = FromRgb(105, 105, 105); - public static readonly Color DodgerBlue = FromRgb(30, 144, 255); - public static readonly Color Firebrick = FromRgb(178, 34, 34); - public static readonly Color FloralWhite = FromRgb(255, 250, 240); - public static readonly Color ForestGreen = FromRgb(34, 139, 34); - public static readonly Color Fuchsia = FromRgb(255, 0, 255); - public static readonly Color Gainsboro = FromRgb(220, 220, 220); - public static readonly Color GhostWhite = FromRgb(248, 248, 255); - public static readonly Color Gold = FromRgb(255, 215, 0); - public static readonly Color Goldenrod = FromRgb(218, 165, 32); - public static readonly Color Gray = FromRgb(128, 128, 128); - public static readonly Color Green = FromRgb(0, 128, 0); - public static readonly Color GreenYellow = FromRgb(173, 255, 47); - public static readonly Color Honeydew = FromRgb(240, 255, 240); - public static readonly Color HotPink = FromRgb(255, 105, 180); - public static readonly Color IndianRed = FromRgb(205, 92, 92); - public static readonly Color Indigo = FromRgb(75, 0, 130); - public static readonly Color Ivory = FromRgb(255, 255, 240); - public static readonly Color Khaki = FromRgb(240, 230, 140); - public static readonly Color Lavender = FromRgb(230, 230, 250); - public static readonly Color LavenderBlush = FromRgb(255, 240, 245); - public static readonly Color LawnGreen = FromRgb(124, 252, 0); - public static readonly Color LemonChiffon = FromRgb(255, 250, 205); - public static readonly Color LightBlue = FromRgb(173, 216, 230); - public static readonly Color LightCoral = FromRgb(240, 128, 128); - public static readonly Color LightCyan = FromRgb(224, 255, 255); - public static readonly Color LightGoldenrodYellow = FromRgb(250, 250, 210); - public static readonly Color LightGray = FromRgb(211, 211, 211); - public static readonly Color LightGreen = FromRgb(144, 238, 144); - public static readonly Color LightPink = FromRgb(255, 182, 193); - public static readonly Color LightSalmon = FromRgb(255, 160, 122); - public static readonly Color LightSeaGreen = FromRgb(32, 178, 170); - public static readonly Color LightSkyBlue = FromRgb(135, 206, 250); - public static readonly Color LightSlateGray = FromRgb(119, 136, 153); - public static readonly Color LightSteelBlue = FromRgb(176, 196, 222); - public static readonly Color LightYellow = FromRgb(255, 255, 224); - public static readonly Color Lime = FromRgb(0, 255, 0); - public static readonly Color LimeGreen = FromRgb(50, 205, 50); - public static readonly Color Linen = FromRgb(250, 240, 230); - public static readonly Color Magenta = FromRgb(255, 0, 255); - public static readonly Color Maroon = FromRgb(128, 0, 0); - public static readonly Color MediumAquamarine = FromRgb(102, 205, 170); - public static readonly Color MediumBlue = FromRgb(0, 0, 205); - public static readonly Color MediumOrchid = FromRgb(186, 85, 211); - public static readonly Color MediumPurple = FromRgb(147, 112, 219); - public static readonly Color MediumSeaGreen = FromRgb(60, 179, 113); - public static readonly Color MediumSlateBlue = FromRgb(123, 104, 238); - public static readonly Color MediumSpringGreen = FromRgb(0, 250, 154); - public static readonly Color MediumTurquoise = FromRgb(72, 209, 204); - public static readonly Color MediumVioletRed = FromRgb(199, 21, 133); - public static readonly Color MidnightBlue = FromRgb(25, 25, 112); - public static readonly Color MintCream = FromRgb(245, 255, 250); - public static readonly Color MistyRose = FromRgb(255, 228, 225); - public static readonly Color Moccasin = FromRgb(255, 228, 181); - public static readonly Color NavajoWhite = FromRgb(255, 222, 173); - public static readonly Color Navy = FromRgb(0, 0, 128); - public static readonly Color OldLace = FromRgb(253, 245, 230); - public static readonly Color Olive = FromRgb(128, 128, 0); - public static readonly Color OliveDrab = FromRgb(107, 142, 35); - public static readonly Color Orange = FromRgb(255, 165, 0); - public static readonly Color OrangeRed = FromRgb(255, 69, 0); - public static readonly Color Orchid = FromRgb(218, 112, 214); - public static readonly Color PaleGoldenrod = FromRgb(238, 232, 170); - public static readonly Color PaleGreen = FromRgb(152, 251, 152); - public static readonly Color PaleTurquoise = FromRgb(175, 238, 238); - public static readonly Color PaleVioletRed = FromRgb(219, 112, 147); - public static readonly Color PapayaWhip = FromRgb(255, 239, 213); - public static readonly Color PeachPuff = FromRgb(255, 218, 185); - public static readonly Color Peru = FromRgb(205, 133, 63); - public static readonly Color Pink = FromRgb(255, 192, 203); - public static readonly Color Plum = FromRgb(221, 160, 221); - public static readonly Color PowderBlue = FromRgb(176, 224, 230); - public static readonly Color Purple = FromRgb(128, 0, 128); - public static readonly Color Red = FromRgb(255, 0, 0); - public static readonly Color RosyBrown = FromRgb(188, 143, 143); - public static readonly Color RoyalBlue = FromRgb(65, 105, 225); - public static readonly Color SaddleBrown = FromRgb(139, 69, 19); - public static readonly Color Salmon = FromRgb(250, 128, 114); - public static readonly Color SandyBrown = FromRgb(244, 164, 96); - public static readonly Color SeaGreen = FromRgb(46, 139, 87); - public static readonly Color SeaShell = FromRgb(255, 245, 238); - public static readonly Color Sienna = FromRgb(160, 82, 45); - public static readonly Color Silver = FromRgb(192, 192, 192); - public static readonly Color SkyBlue = FromRgb(135, 206, 235); - public static readonly Color SlateBlue = FromRgb(106, 90, 205); - public static readonly Color SlateGray = FromRgb(112, 128, 144); - public static readonly Color Snow = FromRgb(255, 250, 250); - public static readonly Color SpringGreen = FromRgb(0, 255, 127); - public static readonly Color SteelBlue = FromRgb(70, 130, 180); - public static readonly Color Tan = FromRgb(210, 180, 140); - public static readonly Color Teal = FromRgb(0, 128, 128); - public static readonly Color Thistle = FromRgb(216, 191, 216); - public static readonly Color Tomato = FromRgb(255, 99, 71); - public static readonly Color Transparent = FromRgba(255, 255, 255, 0); - public static readonly Color Turquoise = FromRgb(64, 224, 208); - public static readonly Color Violet = FromRgb(238, 130, 238); - public static readonly Color Wheat = FromRgb(245, 222, 179); - public static readonly Color White = FromRgb(255, 255, 255); - public static readonly Color WhiteSmoke = FromRgb(245, 245, 245); - public static readonly Color Yellow = FromRgb(255, 255, 0); - public static readonly Color YellowGreen = FromRgb(154, 205, 50); + public static readonly Color AliceBlue = FromRgb(240, 248, 255); + public static readonly Color AntiqueWhite = FromRgb(250, 235, 215); + public static readonly Color Aqua = FromRgb(0, 255, 255); + public static readonly Color Aquamarine = FromRgb(127, 255, 212); + public static readonly Color Azure = FromRgb(240, 255, 255); + public static readonly Color Beige = FromRgb(245, 245, 220); + public static readonly Color Bisque = FromRgb(255, 228, 196); + public static readonly Color Black = FromRgb(0, 0, 0); + public static readonly Color BlanchedAlmond = FromRgb(255, 235, 205); + public static readonly Color Blue = FromRgb(0, 0, 255); + public static readonly Color BlueViolet = FromRgb(138, 43, 226); + public static readonly Color Brown = FromRgb(165, 42, 42); + public static readonly Color BurlyWood = FromRgb(222, 184, 135); + public static readonly Color CadetBlue = FromRgb(95, 158, 160); + public static readonly Color Chartreuse = FromRgb(127, 255, 0); + public static readonly Color Chocolate = FromRgb(210, 105, 30); + public static readonly Color Coral = FromRgb(255, 127, 80); + public static readonly Color CornflowerBlue = FromRgb(100, 149, 237); + public static readonly Color Cornsilk = FromRgb(255, 248, 220); + public static readonly Color Crimson = FromRgb(220, 20, 60); + public static readonly Color Cyan = FromRgb(0, 255, 255); + public static readonly Color DarkBlue = FromRgb(0, 0, 139); + public static readonly Color DarkCyan = FromRgb(0, 139, 139); + public static readonly Color DarkGoldenrod = FromRgb(184, 134, 11); + public static readonly Color DarkGray = FromRgb(169, 169, 169); + public static readonly Color DarkGreen = FromRgb(0, 100, 0); + public static readonly Color DarkKhaki = FromRgb(189, 183, 107); + public static readonly Color DarkMagenta = FromRgb(139, 0, 139); + public static readonly Color DarkOliveGreen = FromRgb(85, 107, 47); + public static readonly Color DarkOrange = FromRgb(255, 140, 0); + public static readonly Color DarkOrchid = FromRgb(153, 50, 204); + public static readonly Color DarkRed = FromRgb(139, 0, 0); + public static readonly Color DarkSalmon = FromRgb(233, 150, 122); + public static readonly Color DarkSeaGreen = FromRgb(143, 188, 143); + public static readonly Color DarkSlateBlue = FromRgb(72, 61, 139); + public static readonly Color DarkSlateGray = FromRgb(47, 79, 79); + public static readonly Color DarkTurquoise = FromRgb(0, 206, 209); + public static readonly Color DarkViolet = FromRgb(148, 0, 211); + public static readonly Color DeepPink = FromRgb(255, 20, 147); + public static readonly Color DeepSkyBlue = FromRgb(0, 191, 255); + public static readonly Color DimGray = FromRgb(105, 105, 105); + public static readonly Color DodgerBlue = FromRgb(30, 144, 255); + public static readonly Color Firebrick = FromRgb(178, 34, 34); + public static readonly Color FloralWhite = FromRgb(255, 250, 240); + public static readonly Color ForestGreen = FromRgb(34, 139, 34); + public static readonly Color Fuchsia = FromRgb(255, 0, 255); + public static readonly Color Gainsboro = FromRgb(220, 220, 220); + public static readonly Color GhostWhite = FromRgb(248, 248, 255); + public static readonly Color Gold = FromRgb(255, 215, 0); + public static readonly Color Goldenrod = FromRgb(218, 165, 32); + public static readonly Color Gray = FromRgb(128, 128, 128); + public static readonly Color Green = FromRgb(0, 128, 0); + public static readonly Color GreenYellow = FromRgb(173, 255, 47); + public static readonly Color Honeydew = FromRgb(240, 255, 240); + public static readonly Color HotPink = FromRgb(255, 105, 180); + public static readonly Color IndianRed = FromRgb(205, 92, 92); + public static readonly Color Indigo = FromRgb(75, 0, 130); + public static readonly Color Ivory = FromRgb(255, 255, 240); + public static readonly Color Khaki = FromRgb(240, 230, 140); + public static readonly Color Lavender = FromRgb(230, 230, 250); + public static readonly Color LavenderBlush = FromRgb(255, 240, 245); + public static readonly Color LawnGreen = FromRgb(124, 252, 0); + public static readonly Color LemonChiffon = FromRgb(255, 250, 205); + public static readonly Color LightBlue = FromRgb(173, 216, 230); + public static readonly Color LightCoral = FromRgb(240, 128, 128); + public static readonly Color LightCyan = FromRgb(224, 255, 255); + public static readonly Color LightGoldenrodYellow = FromRgb(250, 250, 210); + public static readonly Color LightGray = FromRgb(211, 211, 211); + public static readonly Color LightGreen = FromRgb(144, 238, 144); + public static readonly Color LightPink = FromRgb(255, 182, 193); + public static readonly Color LightSalmon = FromRgb(255, 160, 122); + public static readonly Color LightSeaGreen = FromRgb(32, 178, 170); + public static readonly Color LightSkyBlue = FromRgb(135, 206, 250); + public static readonly Color LightSlateGray = FromRgb(119, 136, 153); + public static readonly Color LightSteelBlue = FromRgb(176, 196, 222); + public static readonly Color LightYellow = FromRgb(255, 255, 224); + public static readonly Color Lime = FromRgb(0, 255, 0); + public static readonly Color LimeGreen = FromRgb(50, 205, 50); + public static readonly Color Linen = FromRgb(250, 240, 230); + public static readonly Color Magenta = FromRgb(255, 0, 255); + public static readonly Color Maroon = FromRgb(128, 0, 0); + public static readonly Color MediumAquamarine = FromRgb(102, 205, 170); + public static readonly Color MediumBlue = FromRgb(0, 0, 205); + public static readonly Color MediumOrchid = FromRgb(186, 85, 211); + public static readonly Color MediumPurple = FromRgb(147, 112, 219); + public static readonly Color MediumSeaGreen = FromRgb(60, 179, 113); + public static readonly Color MediumSlateBlue = FromRgb(123, 104, 238); + public static readonly Color MediumSpringGreen = FromRgb(0, 250, 154); + public static readonly Color MediumTurquoise = FromRgb(72, 209, 204); + public static readonly Color MediumVioletRed = FromRgb(199, 21, 133); + public static readonly Color MidnightBlue = FromRgb(25, 25, 112); + public static readonly Color MintCream = FromRgb(245, 255, 250); + public static readonly Color MistyRose = FromRgb(255, 228, 225); + public static readonly Color Moccasin = FromRgb(255, 228, 181); + public static readonly Color NavajoWhite = FromRgb(255, 222, 173); + public static readonly Color Navy = FromRgb(0, 0, 128); + public static readonly Color OldLace = FromRgb(253, 245, 230); + public static readonly Color Olive = FromRgb(128, 128, 0); + public static readonly Color OliveDrab = FromRgb(107, 142, 35); + public static readonly Color Orange = FromRgb(255, 165, 0); + public static readonly Color OrangeRed = FromRgb(255, 69, 0); + public static readonly Color Orchid = FromRgb(218, 112, 214); + public static readonly Color PaleGoldenrod = FromRgb(238, 232, 170); + public static readonly Color PaleGreen = FromRgb(152, 251, 152); + public static readonly Color PaleTurquoise = FromRgb(175, 238, 238); + public static readonly Color PaleVioletRed = FromRgb(219, 112, 147); + public static readonly Color PapayaWhip = FromRgb(255, 239, 213); + public static readonly Color PeachPuff = FromRgb(255, 218, 185); + public static readonly Color Peru = FromRgb(205, 133, 63); + public static readonly Color Pink = FromRgb(255, 192, 203); + public static readonly Color Plum = FromRgb(221, 160, 221); + public static readonly Color PowderBlue = FromRgb(176, 224, 230); + public static readonly Color Purple = FromRgb(128, 0, 128); + public static readonly Color Red = FromRgb(255, 0, 0); + public static readonly Color RosyBrown = FromRgb(188, 143, 143); + public static readonly Color RoyalBlue = FromRgb(65, 105, 225); + public static readonly Color SaddleBrown = FromRgb(139, 69, 19); + public static readonly Color Salmon = FromRgb(250, 128, 114); + public static readonly Color SandyBrown = FromRgb(244, 164, 96); + public static readonly Color SeaGreen = FromRgb(46, 139, 87); + public static readonly Color SeaShell = FromRgb(255, 245, 238); + public static readonly Color Sienna = FromRgb(160, 82, 45); + public static readonly Color Silver = FromRgb(192, 192, 192); + public static readonly Color SkyBlue = FromRgb(135, 206, 235); + public static readonly Color SlateBlue = FromRgb(106, 90, 205); + public static readonly Color SlateGray = FromRgb(112, 128, 144); + public static readonly Color Snow = FromRgb(255, 250, 250); + public static readonly Color SpringGreen = FromRgb(0, 255, 127); + public static readonly Color SteelBlue = FromRgb(70, 130, 180); + public static readonly Color Tan = FromRgb(210, 180, 140); + public static readonly Color Teal = FromRgb(0, 128, 128); + public static readonly Color Thistle = FromRgb(216, 191, 216); + public static readonly Color Tomato = FromRgb(255, 99, 71); + public static readonly Color Transparent = FromRgba(255, 255, 255, 0); + public static readonly Color Turquoise = FromRgb(64, 224, 208); + public static readonly Color Violet = FromRgb(238, 130, 238); + public static readonly Color Wheat = FromRgb(245, 222, 179); + public static readonly Color White = FromRgb(255, 255, 255); + public static readonly Color WhiteSmoke = FromRgb(245, 245, 245); + public static readonly Color Yellow = FromRgb(255, 255, 0); + public static readonly Color YellowGreen = FromRgb(154, 205, 50); #pragma warning restore CS1591 // Missing XML comment for publicly visible type or member - } } \ No newline at end of file