Address review comments

Author: ttencate

godot-core/src/builtin/color.rs

@@ -32,25 +32,22 @@ impl Color {
     // TODO implement all the other color constants using code generation
 
     /// Transparent black.
-    pub const TRANSPARENT_BLACK: Color = Self::new(0.0, 0.0, 0.0, 0.0);
+    pub const TRANSPARENT_BLACK: Color = Self::from_rgba(0.0, 0.0, 0.0, 0.0);
 
-    /// Transparent white. Equivalent of `Color.TRANSPARENT` in GDScript.
-    pub const TRANSPARENT_WHITE: Color = Self::new(1.0, 1.0, 1.0, 0.0);
+    /// Transparent white.
+    ///
+    /// _Godot equivalent: `Color.TRANSPARENT`_
+    pub const TRANSPARENT_WHITE: Color = Self::from_rgba(1.0, 1.0, 1.0, 0.0);
 
     /// Opaque black.
-    pub const BLACK: Color = Self::new(0.0, 0.0, 0.0, 1.0);
+    pub const BLACK: Color = Self::from_rgba(0.0, 0.0, 0.0, 1.0);
 
     /// Opaque white.
-    pub const WHITE: Color = Self::new(1.0, 1.0, 1.0, 1.0);
+    pub const WHITE: Color = Self::from_rgba(1.0, 1.0, 1.0, 1.0);
 
     /// Constructs a new `Color` with the given components.
-    pub const fn new(r: f32, g: f32, b: f32, a: f32) -> Self {
-        Self { r, g, b, a }
-    }
-
-    /// Constructs a new `Color` with the given components. More explicit alias of [`Color::new`].
     pub const fn from_rgba(r: f32, g: f32, b: f32, a: f32) -> Self {
-        Self::new(r, g, b, a)
+        Self { r, g, b, a }
     }
 
     /// Constructs a new `Color` with the given color components, and the alpha channel set to 1.
@@ -59,26 +56,30 @@ impl Color {
     }
 
     /// Constructs a new `Color` with the given components as bytes. 0 is mapped to 0.0, 255 is
-    /// mapped to 1.0. Equivalent of the global constructor function `Color8` in GDScript.
+    /// mapped to 1.0.
+    ///
+    /// _Godot equivalent: the global `Color8` function_
     pub fn from_rgba8(r: u8, g: u8, b: u8, a: u8) -> Self {
         Self::from_rgba(from_u8(r), from_u8(g), from_u8(b), from_u8(a))
     }
 
-    /// Constructs a new `Color` with the given components as bytes. 0 is mapped to 0.0, 65535
-    /// (`0xffff`) is mapped to 1.0.
+    /// Constructs a new `Color` with the given components as `u16` words. 0 is mapped to 0.0,
+    /// 65535 (`0xffff`) is mapped to 1.0.
     pub fn from_rgba16(r: u16, g: u16, b: u16, a: u16) -> Self {
         Self::from_rgba(from_u16(r), from_u16(g), from_u16(b), from_u16(a))
     }
 
-    /// Constructs a new `Color` from a 32-bits value with the given channel `order`. Passing
-    /// `ColorChannelOrder::Rgba` is the equivalent of `Color.hex` in GDScript.
+    /// Constructs a new `Color` from a 32-bits value with the given channel `order`.
+    ///
+    /// _Godot equivalent: `Color.hex`, if `ColorChannelOrder::Rgba` is used_
     pub fn from_u32_rgba(u: u32, order: ColorChannelOrder) -> Self {
         let [r, g, b, a] = order.unpack(u.to_be_bytes());
         Color::from_rgba8(r, g, b, a)
     }
 
-    /// Constructs a new `Color` from a 64-bits value with the given channel `order`. Passing
-    /// `ColorChannelOrder::Rgba` is the equivalent of `Color.hex64` in GDScript.
+    /// Constructs a new `Color` from a 64-bits value with the given channel `order`.
+    ///
+    /// _Godot equivalent: `Color.hex64`, if `ColorChannelOrder::Rgba` is used_
     pub fn from_u64_rgba(u: u64, order: ColorChannelOrder) -> Self {
         let [r, g, b, a] = order.unpack(to_be_words(u));
         Color::from_rgba16(r, g, b, a)
@@ -109,12 +110,14 @@ impl Color {
     ///
     /// Returns `None` if the string is neither a valid HTML color code nor an existing color name.
     ///
+    /// Most color constants have an alpha of 1; use [`Color::with_alpha`] to change it.
+    ///
     /// [color_constants]: https://docs.godotengine.org/en/latest/classes/class_color.html#constants
     /// [cheat_sheet]: https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png
     pub fn from_string<S: Into<GodotString>>(string: S) -> Option<Self> {
         let color = InnerColor::from_string(
             string.into(),
-            Self::new(f32::NAN, f32::NAN, f32::NAN, f32::NAN),
+            Self::from_rgba(f32::NAN, f32::NAN, f32::NAN, f32::NAN),
         );
         // Assumption: the implementation of `from_string` in the engine will never return any NaN
         // upon success.
@@ -125,12 +128,17 @@ impl Color {
         }
     }
 
-    /// Equivalent to [`Color::from_hsva`] with `a` set to 1.0.
+    /// Constructs a `Color` from an [HSV profile](https://en.wikipedia.org/wiki/HSL_and_HSV). The
+    /// hue (`h`), saturation (`s`), and value (`v`) are typically between 0.0 and 1.0. Alpha is
+    /// set to 1; use [`Color::with_alpha`] to change it.
     pub fn from_hsv(h: f64, s: f64, v: f64) -> Self {
         InnerColor::from_hsv(h, s, v, 1.0)
     }
 
-    /// Equivalent to [`Color::from_ok_hsl`] with `a` set to 1.0.
+    /// Constructs a `Color` from an [OK HSL
+    /// profile](https://bottosson.github.io/posts/colorpicker/). The hue (`h`), saturation (`s`),
+    /// and lightness (`l`) are typically between 0.0 and 1.0. Alpha is set to 1; use
+    /// [`Color::with_alpha`] to change it.
     pub fn from_ok_hsl(h: f64, s: f64, l: f64) -> Self {
         InnerColor::from_ok_hsl(h, s, l, 1.0)
     }
@@ -241,7 +249,7 @@ impl Color {
     }
 
     /// Returns the color with its `r`, `g`, and `b` components inverted:
-    /// `Color::new(1 - r, 1 - g, 1 - b, a)`.
+    /// `Color::from_rgba(1 - r, 1 - g, 1 - b, a)`.
     #[must_use]
     pub fn inverted(self) -> Self {
         self.as_inner().inverted()
@@ -465,7 +473,7 @@ impl ops::SubAssign<Color> for Color {
 impl ops::Neg for Color {
     type Output = Self;
     fn neg(self) -> Self {
-        Self::new(-self.r, -self.g, -self.b, -self.a)
+        Self::from_rgba(-self.r, -self.g, -self.b, -self.a)
     }
 }
 

itest/rust/build.rs

@@ -39,7 +39,7 @@ fn collect_inputs() -> Vec<Input> {
     push!(inputs; float, f32, 12.5);
     push!(inputs; float, f64, 127.83156478);
     push!(inputs; bool, bool, true);
-    push!(inputs; Color, Color, Color(0.7, 0.5, 0.3, 0.2), Color::new(0.7, 0.5, 0.3, 0.2));
+    push!(inputs; Color, Color, Color(0.7, 0.5, 0.3, 0.2), Color::from_rgba(0.7, 0.5, 0.3, 0.2));
     push!(inputs; String, GodotString, "hello", "hello".into());
     push!(inputs; Vector2, Vector2, Vector2(12.5, -3.5), Vector2::new(12.5, -3.5));
     push!(inputs; Vector3, Vector3, Vector3(117.5, 100.0, -323.25), Vector3::new(117.5, 100.0, -323.25));

itest/rust/src/codegen_test.rs

@@ -45,7 +45,7 @@ fn codegen_static_builtin_method() {
     assert_eq!(pi, GodotString::from("3.142"));
 
     let col = InnerColor::html("#663399cc".into());
-    assert_eq!(col, Color::new(0.4, 0.2, 0.6, 0.8));
+    assert_eq!(col, Color::from_rgba(0.4, 0.2, 0.6, 0.8));
 }
 
 #[itest]