Clarified Hue Bounds

bevyengine · Sep 5, 2023 · 6a09348 · 6a09348
1 parent f464deb
commit 6a09348
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/crates/bevy_render/src/color/mod.rs b/crates/bevy_render/src/color/mod.rs
@@ -196,7 +196,7 @@ impl Color {
     ///
     /// # Arguments
     ///
-    /// * `hue` - Hue channel. [0.0, 360.0]
+    /// * `hue` - Hue channel. [-180.0, 180.0]
     /// * `saturation` - Saturation channel. [0.0, 1.0]
     /// * `lightness` - Lightness channel. [0.0, 1.0]
     /// * `alpha` - Alpha channel. [0.0, 1.0]
@@ -216,7 +216,7 @@ impl Color {
     ///
     /// # Arguments
     ///
-    /// * `hue` - Hue channel. [0.0, 360.0]
+    /// * `hue` - Hue channel. [-180.0, 180.0]
     /// * `saturation` - Saturation channel. [0.0, 1.0]
     /// * `lightness` - Lightness channel. [0.0, 1.0]
     ///
@@ -237,7 +237,7 @@ impl Color {
     ///
     /// * `lightness` - Lightness channel. [0.0, 1.5]
     /// * `chroma` - Chroma channel. [0.0, 1.5]
-    /// * `hue` - Hue channel. [0.0, 360.0]
+    /// * `hue` - Hue channel. [-180.0, 180.0]
     /// * `alpha` - Alpha channel. [0.0, 1.0]
     ///
     /// See also [`Color::lch`].
@@ -256,7 +256,7 @@ impl Color {
     ///
     /// * `lightness` - Lightness channel. [0.0, 1.5]
     /// * `chroma` - Chroma channel. [0.0, 1.5]
-    /// * `hue` - Hue channel. [0.0, 360.0]
+    /// * `hue` - Hue channel. [-180.0, 180.0]
     ///
     /// See also [`Color::lcha`].
     pub fn lch(lightness: f32, chroma: f32, hue: f32) -> Color {
@@ -963,5 +963,9 @@ mod tests {
         let color_mix = color_start.mix_in::<palette::Oklcha>(color_end, 0.5);
 
         assert_eq!(color_mix, Color::rgba(0.7299066, 0., 0.7600829, 1.));
+
+        let hue = color_start.in_space::<palette::Oklcha>().hue.into_degrees();
+
+        assert_eq!(hue, -95.94797);
     }
 }