Merge pull request #69867 from raulsntos/dotnet/color

C#: Synchronize Color with Core

2 files changed, 157 insertions, 12 deletions

diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs
index f49023555b..4075a878d2 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Runtime.InteropServices;
+using Godot.NativeInterop;
 
 namespace Godot
 {
@@ -187,6 +188,19 @@ namespace Godot
         }
 
         /// <summary>
+        /// Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclusive).
+        /// This is useful when determining light or dark color. Colors with a luminance smaller
+        /// than 0.5 can be generally considered dark.
+        /// Note: <see cref="Luminance"/> relies on the color being in the linear color space to
+        /// return an accurate relative luminance value. If the color is in the sRGB color space
+        /// use <see cref="SrgbToLinear"/> to convert it to the linear color space first.
+        /// </summary>
+        public readonly float Luminance
+        {
+            get { return 0.2126f * r + 0.7152f * g + 0.0722f * b; }
+        }
+
+        /// <summary>
         /// Access color components using their index.
         /// </summary>
         /// <value>
@@ -363,6 +377,35 @@ namespace Godot
         }
 
         /// <summary>
+        /// Returns the color converted to the sRGB color space.
+        /// This method assumes the original color is in the linear color space.
+        /// See also <see cref="SrgbToLinear"/> which performs the opposite operation.
+        /// </summary>
+        /// <returns>The sRGB color.</returns>
+        public readonly Color LinearToSrgb()
+        {
+            return new Color(
+                r < 0.0031308f ? 12.92f * r : (1.0f + 0.055f) * (float)Mathf.Pow(r, 1.0f / 2.4f) - 0.055f,
+                g < 0.0031308f ? 12.92f * g : (1.0f + 0.055f) * (float)Mathf.Pow(g, 1.0f / 2.4f) - 0.055f,
+                b < 0.0031308f ? 12.92f * b : (1.0f + 0.055f) * (float)Mathf.Pow(b, 1.0f / 2.4f) - 0.055f, a);
+        }
+
+        /// <summary>
+        /// Returns the color converted to linear color space.
+        /// This method assumes the original color already is in sRGB color space.
+        /// See also <see cref="LinearToSrgb"/> which performs the opposite operation.
+        /// </summary>
+        /// <returns>The color in linear color space.</returns>
+        public readonly Color SrgbToLinear()
+        {
+            return new Color(
+                r < 0.04045f ? r * (1.0f / 12.92f) : (float)Mathf.Pow((r + 0.055f) * (float)(1.0 / (1.0 + 0.055)), 2.4f),
+                g < 0.04045f ? g * (1.0f / 12.92f) : (float)Mathf.Pow((g + 0.055f) * (float)(1.0 / (1.0 + 0.055)), 2.4f),
+                b < 0.04045f ? b * (1.0f / 12.92f) : (float)Mathf.Pow((b + 0.055f) * (float)(1.0 / (1.0 + 0.055)), 2.4f),
+                a);
+        }
+
+        /// <summary>
         /// Returns the color converted to an unsigned 32-bit integer in ABGR
         /// format (each byte represents a color channel).
         /// ABGR is the reversed version of the default format.
@@ -565,6 +608,10 @@ namespace Godot
         /// <see cref="Colors"/> constants.
         /// </summary>
         /// <param name="code">The HTML color code or color name to construct from.</param>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// A color cannot be inferred from the given <paramref name="code"/>.
+        /// It was invalid HTML and a color with that name was not found.
+        /// </exception>
         public Color(string code)
         {
             if (HtmlIsValid(code))
@@ -597,7 +644,7 @@ namespace Godot
         /// <exception name="ArgumentOutOfRangeException">
         /// <paramref name="rgba"/> color code is invalid.
         /// </exception>
-        private static Color FromHTML(ReadOnlySpan<char> rgba)
+        public static Color FromHTML(ReadOnlySpan<char> rgba)
         {
             Color c;
             if (rgba.Length == 0)
@@ -705,28 +752,59 @@ namespace Godot
         /// the constants defined in <see cref="Colors"/>.
         /// </summary>
         /// <param name="name">The name of the color.</param>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// A color with the given name is not found.
+        /// </exception>
         /// <returns>The constructed color.</returns>
         private static Color Named(string name)
         {
+            if (!FindNamedColor(name, out Color color))
+            {
+                throw new ArgumentOutOfRangeException($"Invalid Color Name: {name}");
+            }
+
+            return color;
+        }
+
+        /// <summary>
+        /// Returns a color according to the standardized name, with the
+        /// specified alpha value. Supported color names are the same as
+        /// the constants defined in <see cref="Colors"/>.
+        /// If a color with the given name is not found, it returns
+        /// <paramref name="default"/>.
+        /// </summary>
+        /// <param name="name">The name of the color.</param>
+        /// <param name="default">
+        /// The default color to return when a color with the given name
+        /// is not found.
+        /// </param>
+        /// <returns>The constructed color.</returns>
+        private static Color Named(string name, Color @default)
+        {
+            if (!FindNamedColor(name, out Color color))
+            {
+                return @default;
+            }
+
+            return color;
+        }
+
+        private static bool FindNamedColor(string name, out Color color)
+        {
             name = name.Replace(" ", string.Empty);
             name = name.Replace("-", string.Empty);
             name = name.Replace("_", string.Empty);
             name = name.Replace("'", string.Empty);
             name = name.Replace(".", string.Empty);
-            name = name.ToUpper();
-
-            if (!Colors.namedColors.ContainsKey(name))
-            {
-                throw new ArgumentOutOfRangeException($"Invalid Color Name: {name}");
-            }
+            name = name.ToUpperInvariant();
 
-            return Colors.namedColors[name];
+            return Colors.namedColors.TryGetValue(name, out color);
         }
 
         /// <summary>
-        /// Constructs a color from an HSV profile, with values on the
-        /// range of 0 to 1. This is equivalent to using each of
-        /// the <c>h</c>/<c>s</c>/<c>v</c> properties, but much more efficient.
+        /// Constructs a color from an HSV profile. The <paramref name="hue"/>,
+        /// <paramref name="saturation"/>, and <paramref name="value"/> are typically
+        /// between 0.0 and 1.0.
         /// </summary>
         /// <param name="hue">The HSV hue, typically on the range of 0 to 1.</param>
         /// <param name="saturation">The HSV saturation, typically on the range of 0 to 1.</param>
@@ -841,13 +919,78 @@ namespace Godot
             return ParseCol4(str, index) * 16 + ParseCol4(str, index + 1);
         }
 
+        /// <summary>
+        /// Constructs a color from an OK HSL profile. The <paramref name="hue"/>,
+        /// <paramref name="saturation"/>, and <paramref name="lightness"/> are typically
+        /// between 0.0 and 1.0.
+        /// </summary>
+        /// <param name="hue">The OK HSL hue, typically on the range of 0 to 1.</param>
+        /// <param name="saturation">The OK HSL saturation, typically on the range of 0 to 1.</param>
+        /// <param name="lightness">The OK HSL lightness, typically on the range of 0 to 1.</param>
+        /// <param name="alpha">The alpha (transparency) value, typically on the range of 0 to 1.</param>
+        /// <returns>The constructed color.</returns>
+        public static Color FromOkHsl(float hue, float saturation, float lightness, float alpha = 1.0f)
+        {
+            return NativeFuncs.godotsharp_color_from_ok_hsl(hue, saturation, lightness, alpha);
+        }
+
+        /// <summary>
+        /// Encodes a <see cref="Color"/> from a RGBE9995 format integer.
+        /// See <see cref="Image.Format.Rgbe9995"/>.
+        /// </summary>
+        /// <param name="rgbe">The RGBE9995 encoded color.</param>
+        /// <returns>The constructed color.</returns>
+        public static Color FromRgbe9995(uint rgbe)
+        {
+            float r = rgbe & 0x1ff;
+            float g = (rgbe >> 9) & 0x1ff;
+            float b = (rgbe >> 18) & 0x1ff;
+            float e = rgbe >> 27;
+            float m = (float)Mathf.Pow(2.0f, e - 15.0f - 9.0f);
+
+            float rd = r * m;
+            float gd = g * m;
+            float bd = b * m;
+
+            return new Color(rd, gd, bd, 1.0f);
+        }
+
+        /// <summary>
+        /// Constructs a color from the given string, which can be either an HTML color
+        /// code or a named color. Returns <paramref name="default"/> if the color cannot
+        /// be inferred from the string. Supported color names are the same as the
+        /// <see cref="Colors"/> constants.
+        /// </summary>
+        /// <param name="str">The HTML color code or color name.</param>
+        /// <param name="default">The fallback color to return if the color cannot be inferred.</param>
+        /// <returns>The constructed color.</returns>
+        public static Color FromString(string str, Color @default)
+        {
+            if (HtmlIsValid(str))
+            {
+                return FromHTML(str);
+            }
+            else
+            {
+                return Named(str, @default);
+            }
+        }
+
         private static string ToHex32(float val)
         {
             byte b = (byte)Mathf.RoundToInt(Mathf.Clamp(val * 255, 0, 255));
             return b.HexEncode();
         }
 
-        internal static bool HtmlIsValid(ReadOnlySpan<char> color)
+        /// <summary>
+        /// Returns <see langword="true"/> if <paramref name="color"/> is a valid HTML hexadecimal
+        /// color string. The string must be a hexadecimal value (case-insensitive) of either 3,
+        /// 4, 6 or 8 digits, and may be prefixed by a hash sign (<c>#</c>). This method is
+        /// identical to <see cref="StringExtensions.IsValidHtmlColor(string)"/>.
+        /// </summary>
+        /// <param name="color">The HTML hexadecimal color string.</param>
+        /// <returns>Whether or not the string was a valid HTML hexadecimal color string.</returns>
+        public static bool HtmlIsValid(ReadOnlySpan<char> color)
         {
             if (color.IsEmpty)
             {
diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/NativeInterop/NativeFuncs.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/NativeInterop/NativeFuncs.cs
index c7deb6423b..57488bd586 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/NativeInterop/NativeFuncs.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/NativeInterop/NativeFuncs.cs
@@ -153,6 +153,8 @@ namespace Godot.NativeInterop
         internal static partial void godotsharp_callable_call_deferred(in godot_callable p_callable,
             godot_variant** p_args, int p_arg_count);
 
+        internal static partial Color godotsharp_color_from_ok_hsl(float p_h, float p_s, float p_l, float p_alpha);
+
         // GDNative functions
 
         // gdnative.h