Merge pull request #1194 from godot-rust/qol/all-color-constants

`Color`: const constructors, add `ALL_GODOT_COLORS` constant

Author: Bromeon

godot-core/src/builtin/color.rs

@@ -22,6 +22,8 @@ use sys::{ffi_methods, GodotFfi};
 ///
 /// To access its [**HSVA**](ColorHsv) representation, use [`Color::to_hsv`].
 ///
+/// Predefined colors are available as constants, see the corresponding [`impl` block](#impl-Color-1).
+///
 /// # Godot docs
 ///
 /// [`Color` (stable)](https://docs.godotengine.org/en/stable/classes/class_color.html)
@@ -58,28 +60,29 @@ impl Color {
     /// mapped to 1.0.
     ///
     /// _Godot equivalent: the global `Color8` function_
-    pub fn from_rgba8(r: u8, g: u8, b: u8, a: u8) -> Self {
+    pub const 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 `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 {
+    /// 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 const 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`.
     ///
     /// _Godot equivalent: `Color.hex`, if `ColorChannelOrder::Rgba` is used_
-    pub fn from_u32_rgba(u: u32, order: ColorChannelOrder) -> Self {
+    pub const 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`.
     ///
     /// _Godot equivalent: `Color.hex64`, if `ColorChannelOrder::Rgba` is used_
-    pub fn from_u64_rgba(u: u64, order: ColorChannelOrder) -> Self {
+    pub const 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)
     }
@@ -383,7 +386,7 @@ pub enum ColorChannelOrder {
 }
 
 impl ColorChannelOrder {
-    fn pack<T>(self, rgba: [T; 4]) -> [T; 4] {
+    const fn pack<T: Copy>(self, rgba: [T; 4]) -> [T; 4] {
         let [r, g, b, a] = rgba;
         match self {
             ColorChannelOrder::RGBA => [r, g, b, a],
@@ -392,7 +395,7 @@ impl ColorChannelOrder {
         }
     }
 
-    fn unpack<T>(self, xyzw: [T; 4]) -> [T; 4] {
+    const fn unpack<T: Copy>(self, xyzw: [T; 4]) -> [T; 4] {
         let [x, y, z, w] = xyzw;
         match self {
             ColorChannelOrder::RGBA => [x, y, z, w],
@@ -510,12 +513,12 @@ impl ops::Neg for Color {
 }
 
 /// Converts a single channel byte to a float in the range 0 to 1.
-fn from_u8(byte: u8) -> f32 {
+const fn from_u8(byte: u8) -> f32 {
     byte as f32 / 255.0
 }
 
 /// Converts a single channel `u16` word to a float in the range 0 to 1.
-fn from_u16(byte: u16) -> f32 {
+const fn from_u16(byte: u16) -> f32 {
     byte as f32 / 65535.0
 }
 
@@ -542,7 +545,7 @@ fn from_be_words(words: [u16; 4]) -> u64 {
 }
 
 /// Unpacks a `u64` into four `u16` words in big-endian order.
-fn to_be_words(mut u: u64) -> [u16; 4] {
+const fn to_be_words(mut u: u64) -> [u16; 4] {
     let w = (u & 0xffff) as u16;
     u >>= 16;
     let z = (u & 0xffff) as u16;

godot-core/src/builtin/color_constants.rs

@@ -9,8 +9,9 @@ use crate::builtin::Color;
 
 /// Godot's predefined colors.
 ///
-/// This [visual cheat sheet](https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png)
-/// shows how the colors look.
+/// This [visual cheat sheet](https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png) shows how the colors look.
+///
+/// For a systematic list of all predefined Godot colors, check out the [`ALL_GODOT_COLORS`][Self::ALL_GODOT_COLORS] constant.
 impl Color {
     /// Transparent black.
     ///
@@ -169,4 +170,159 @@ impl Color {
     pub const WHITE_SMOKE: Color = Color::from_rgba(0.960784, 0.960784, 0.960784, 1.0);
     pub const YELLOW: Color = Color::from_rgba(1.0, 1.0, 0.0, 1.0);
     pub const YELLOW_GREEN: Color = Color::from_rgba(0.603922, 0.803922, 0.196078, 1.0);
+
+    /// All colors that Godot itself defines on the `Color` builtin type, in alphabetic order.
+    ///
+    /// Contains tuples where the first element is the name of the color constant, and the second element is the corresponding [`Color`].
+    ///
+    /// Excludes Rust-specific colors like `TRANSPARENT_BLACK` and `TRANSPARENT_WHITE`.
+    ///
+    /// This list may change over time.
+    pub const ALL_GODOT_COLORS: &'static [(&'static str, Color)] = &[
+        ("ALICE_BLUE", Self::ALICE_BLUE),
+        ("ANTIQUE_WHITE", Self::ANTIQUE_WHITE),
+        ("AQUA", Self::AQUA),
+        ("AQUAMARINE", Self::AQUAMARINE),
+        ("AZURE", Self::AZURE),
+        ("BEIGE", Self::BEIGE),
+        ("BISQUE", Self::BISQUE),
+        ("BLACK", Self::BLACK),
+        ("BLANCHED_ALMOND", Self::BLANCHED_ALMOND),
+        ("BLUE", Self::BLUE),
+        ("BLUE_VIOLET", Self::BLUE_VIOLET),
+        ("BROWN", Self::BROWN),
+        ("BURLYWOOD", Self::BURLYWOOD),
+        ("CADET_BLUE", Self::CADET_BLUE),
+        ("CHARTREUSE", Self::CHARTREUSE),
+        ("CHOCOLATE", Self::CHOCOLATE),
+        ("CORAL", Self::CORAL),
+        ("CORNFLOWER_BLUE", Self::CORNFLOWER_BLUE),
+        ("CORNSILK", Self::CORNSILK),
+        ("CRIMSON", Self::CRIMSON),
+        ("CYAN", Self::CYAN),
+        ("DARK_BLUE", Self::DARK_BLUE),
+        ("DARK_CYAN", Self::DARK_CYAN),
+        ("DARK_GOLDENROD", Self::DARK_GOLDENROD),
+        ("DARK_GRAY", Self::DARK_GRAY),
+        ("DARK_GREEN", Self::DARK_GREEN),
+        ("DARK_KHAKI", Self::DARK_KHAKI),
+        ("DARK_MAGENTA", Self::DARK_MAGENTA),
+        ("DARK_OLIVE_GREEN", Self::DARK_OLIVE_GREEN),
+        ("DARK_ORANGE", Self::DARK_ORANGE),
+        ("DARK_ORCHID", Self::DARK_ORCHID),
+        ("DARK_RED", Self::DARK_RED),
+        ("DARK_SALMON", Self::DARK_SALMON),
+        ("DARK_SEA_GREEN", Self::DARK_SEA_GREEN),
+        ("DARK_SLATE_BLUE", Self::DARK_SLATE_BLUE),
+        ("DARK_SLATE_GRAY", Self::DARK_SLATE_GRAY),
+        ("DARK_TURQUOISE", Self::DARK_TURQUOISE),
+        ("DARK_VIOLET", Self::DARK_VIOLET),
+        ("DEEP_PINK", Self::DEEP_PINK),
+        ("DEEP_SKY_BLUE", Self::DEEP_SKY_BLUE),
+        ("DIM_GRAY", Self::DIM_GRAY),
+        ("DODGER_BLUE", Self::DODGER_BLUE),
+        ("FIREBRICK", Self::FIREBRICK),
+        ("FLORAL_WHITE", Self::FLORAL_WHITE),
+        ("FOREST_GREEN", Self::FOREST_GREEN),
+        ("FUCHSIA", Self::FUCHSIA),
+        ("GAINSBORO", Self::GAINSBORO),
+        ("GHOST_WHITE", Self::GHOST_WHITE),
+        ("GOLD", Self::GOLD),
+        ("GOLDENROD", Self::GOLDENROD),
+        ("GRAY", Self::GRAY),
+        ("GREEN", Self::GREEN),
+        ("GREEN_YELLOW", Self::GREEN_YELLOW),
+        ("HONEYDEW", Self::HONEYDEW),
+        ("HOT_PINK", Self::HOT_PINK),
+        ("INDIAN_RED", Self::INDIAN_RED),
+        ("INDIGO", Self::INDIGO),
+        ("IVORY", Self::IVORY),
+        ("KHAKI", Self::KHAKI),
+        ("LAVENDER", Self::LAVENDER),
+        ("LAVENDER_BLUSH", Self::LAVENDER_BLUSH),
+        ("LAWN_GREEN", Self::LAWN_GREEN),
+        ("LEMON_CHIFFON", Self::LEMON_CHIFFON),
+        ("LIGHT_BLUE", Self::LIGHT_BLUE),
+        ("LIGHT_CORAL", Self::LIGHT_CORAL),
+        ("LIGHT_CYAN", Self::LIGHT_CYAN),
+        ("LIGHT_GOLDENROD", Self::LIGHT_GOLDENROD),
+        ("LIGHT_GRAY", Self::LIGHT_GRAY),
+        ("LIGHT_GREEN", Self::LIGHT_GREEN),
+        ("LIGHT_PINK", Self::LIGHT_PINK),
+        ("LIGHT_SALMON", Self::LIGHT_SALMON),
+        ("LIGHT_SEA_GREEN", Self::LIGHT_SEA_GREEN),
+        ("LIGHT_SKY_BLUE", Self::LIGHT_SKY_BLUE),
+        ("LIGHT_SLATE_GRAY", Self::LIGHT_SLATE_GRAY),
+        ("LIGHT_STEEL_BLUE", Self::LIGHT_STEEL_BLUE),
+        ("LIGHT_YELLOW", Self::LIGHT_YELLOW),
+        ("LIME", Self::LIME),
+        ("LIME_GREEN", Self::LIME_GREEN),
+        ("LINEN", Self::LINEN),
+        ("MAGENTA", Self::MAGENTA),
+        ("MAROON", Self::MAROON),
+        ("MEDIUM_AQUAMARINE", Self::MEDIUM_AQUAMARINE),
+        ("MEDIUM_BLUE", Self::MEDIUM_BLUE),
+        ("MEDIUM_ORCHID", Self::MEDIUM_ORCHID),
+        ("MEDIUM_PURPLE", Self::MEDIUM_PURPLE),
+        ("MEDIUM_SEA_GREEN", Self::MEDIUM_SEA_GREEN),
+        ("MEDIUM_SLATE_BLUE", Self::MEDIUM_SLATE_BLUE),
+        ("MEDIUM_SPRING_GREEN", Self::MEDIUM_SPRING_GREEN),
+        ("MEDIUM_TURQUOISE", Self::MEDIUM_TURQUOISE),
+        ("MEDIUM_VIOLET_RED", Self::MEDIUM_VIOLET_RED),
+        ("MIDNIGHT_BLUE", Self::MIDNIGHT_BLUE),
+        ("MINT_CREAM", Self::MINT_CREAM),
+        ("MISTY_ROSE", Self::MISTY_ROSE),
+        ("MOCCASIN", Self::MOCCASIN),
+        ("NAVAJO_WHITE", Self::NAVAJO_WHITE),
+        ("NAVY_BLUE", Self::NAVY_BLUE),
+        ("OLD_LACE", Self::OLD_LACE),
+        ("OLIVE", Self::OLIVE),
+        ("OLIVE_DRAB", Self::OLIVE_DRAB),
+        ("ORANGE", Self::ORANGE),
+        ("ORANGE_RED", Self::ORANGE_RED),
+        ("ORCHID", Self::ORCHID),
+        ("PALE_GOLDENROD", Self::PALE_GOLDENROD),
+        ("PALE_GREEN", Self::PALE_GREEN),
+        ("PALE_TURQUOISE", Self::PALE_TURQUOISE),
+        ("PALE_VIOLET_RED", Self::PALE_VIOLET_RED),
+        ("PAPAYA_WHIP", Self::PAPAYA_WHIP),
+        ("PEACH_PUFF", Self::PEACH_PUFF),
+        ("PERU", Self::PERU),
+        ("PINK", Self::PINK),
+        ("PLUM", Self::PLUM),
+        ("POWDER_BLUE", Self::POWDER_BLUE),
+        ("PURPLE", Self::PURPLE),
+        ("REBECCA_PURPLE", Self::REBECCA_PURPLE),
+        ("RED", Self::RED),
+        ("ROSY_BROWN", Self::ROSY_BROWN),
+        ("ROYAL_BLUE", Self::ROYAL_BLUE),
+        ("SADDLE_BROWN", Self::SADDLE_BROWN),
+        ("SALMON", Self::SALMON),
+        ("SANDY_BROWN", Self::SANDY_BROWN),
+        ("SEA_GREEN", Self::SEA_GREEN),
+        ("SEASHELL", Self::SEASHELL),
+        ("SIENNA", Self::SIENNA),
+        ("SILVER", Self::SILVER),
+        ("SKY_BLUE", Self::SKY_BLUE),
+        ("SLATE_BLUE", Self::SLATE_BLUE),
+        ("SLATE_GRAY", Self::SLATE_GRAY),
+        ("SNOW", Self::SNOW),
+        ("SPRING_GREEN", Self::SPRING_GREEN),
+        ("STEEL_BLUE", Self::STEEL_BLUE),
+        ("TAN", Self::TAN),
+        ("TEAL", Self::TEAL),
+        ("THISTLE", Self::THISTLE),
+        ("TOMATO", Self::TOMATO),
+        ("TURQUOISE", Self::TURQUOISE),
+        ("VIOLET", Self::VIOLET),
+        ("WEB_GRAY", Self::WEB_GRAY),
+        ("WEB_GREEN", Self::WEB_GREEN),
+        ("WEB_MAROON", Self::WEB_MAROON),
+        ("WEB_PURPLE", Self::WEB_PURPLE),
+        ("WHEAT", Self::WHEAT),
+        ("WHITE", Self::WHITE),
+        ("WHITE_SMOKE", Self::WHITE_SMOKE),
+        ("YELLOW", Self::YELLOW),
+        ("YELLOW_GREEN", Self::YELLOW_GREEN),
+    ];
 }