Skip to content

Fix NaN okhsl/okhsv values when lightness approximates 0 or 1 #24691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alice-i-cecile merged 6 commits into from
Jun 22, 2026
Merged

Fix NaN okhsl/okhsv values when lightness approximates 0 or 1 #24691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
20101b0
Add more color tests
beicause Jun 21, 2026
aa3bae2
Fix NaN and arbitrary okhsl/okhsv values when lightness approximates …
beicause Jun 21, 2026
aad4f11
Skip rustfmt `test_colors.rs`
beicause Jun 21, 2026
3ef7846
Remove arbitrary EPSILON
beicause Jun 21, 2026
081622d
Add assertions to the special case in `hsla::test_to_from_srgba_2`
beicause Jun 22, 2026
2c73365
Merge branch 'main' into fix-okhsl-okhsv-nan-lightness-0-1
beicause Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion crates/bevy_color/crates/gen_tests/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ use palette::{Hsl, Hsv, Hwb, IntoColor, Lab, Lch, LinSrgb, Oklab, Oklch, Srgb, X

const TEST_COLORS: &[(f32, f32, f32, &str)] = &[
(0., 0., 0., "black"),
(0., 0., 0.0000002, "black_plus_epsilon"),
(1., 1., 0.9999998, "white_minus_epsilon"),
(1., 1., 1., "white"),
(1., 0., 0., "red"),
(0., 1., 0., "green"),
Expand Down Expand Up @@ -29,7 +31,13 @@ const TEST_COLORS: &[(f32, f32, f32, &str)] = &[
)]
const TEST_COLORS_OKHSL: &[[f32; 3]] = &[
[0., 0., 0.],
[
264.05202063805507,
0.9999976852561692,
0.00019314567939689165,
],
[0., 0., 0.9999999923961898],
[0., 0., 0.9999999758763981],
[29.23388519234263, 1.0000000052082665, 0.5680846525040862],
[142.49533888780996, 0.999999970072876, 0.8445289645307816],
[264.052020638055, 0.9999999966883574, 0.3665653394260194],
Expand All @@ -56,7 +64,13 @@ const TEST_COLORS_OKHSL: &[[f32; 3]] = &[
)]
const TEST_COLORS_OKHSV: &[[f32; 3]] = &[
[0., 0., 0.],
[
264.05202063805507,
0.9999910912349016,
0.0004986484139424938,
],
[0., 0., 0.9999999923961898],
[0., 0., 0.9999999758763981],
[29.23388519234263, 1.0000000118548495, 1.0000000001685643],
[142.49533888780996, 0.9999998547944557, 0.9999999884428643],
[264.052020638055, 0.9999999869716024, 0.9999999646150842],
Expand All @@ -77,7 +91,8 @@ const TEST_COLORS_OKHSV: &[[f32; 3]] = &[

fn main() {
println!(
"// Generated by gen_tests. Do not edit.
"#![cfg_attr(rustfmt, rustfmt::skip)]
// Generated by gen_tests. Do not edit.
#[cfg(test)]
use crate::{{
Hsla, Hsva, Hwba, Laba, Lcha, LinearRgba, Okhsla, Okhsva, Oklaba, Oklcha, Srgba, Xyza,
Expand Down
10 changes: 9 additions & 1 deletion crates/bevy_color/src/hsla.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,15 @@ mod tests {
rgb2
);
assert_approx_eq!(color.hsl.hue, hsl2.hue, 0.001);
assert_approx_eq!(color.hsl.saturation, hsl2.saturation, 0.001);
if color.name == "white_minus_epsilon" {
// Our implementation differs from `palette`.
// But it's OK because saturation doesn't matter when lightness is 1.0
assert!(color.hsl.saturation != hsl2.saturation);
assert_approx_eq!(color.hsl.lightness, 1.0, 0.001);
assert_approx_eq!(1.0, hsl2.saturation, 0.001);
} else {
assert_approx_eq!(color.hsl.saturation, hsl2.saturation, 0.001);
}
assert_approx_eq!(color.hsl.lightness, hsl2.lightness, 0.001);
assert_approx_eq!(color.hsl.alpha, hsl2.alpha, 0.001);
}
Expand Down
46 changes: 39 additions & 7 deletions crates/bevy_color/src/okcolor_convert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,9 +300,25 @@ pub(crate) fn oklab_to_okhsl(value: Oklaba) -> Okhsla {
b: lab_b,
alpha,
} = value;
let C = ops::sqrt(lab_a * lab_a + lab_b * lab_b);
// Patch: Fixes NaN for pure black and white colors.
if C < f32::EPSILON {
if lab_l >= 1.0 {
return Okhsla {
hue: 0.0,
saturation: 0.0,
lightness: 1.0,
alpha,
};
}
if lab_l <= 0.0 {
return Okhsla {
hue: 0.0,
saturation: 0.0,
lightness: 0.0,
alpha,
};
}
let C = ops::sqrt(lab_a * lab_a + lab_b * lab_b);
if C == 0. {
let l = toe(lab_l);
return Okhsla {
hue: 0.,
Expand Down Expand Up @@ -360,9 +376,9 @@ pub(crate) fn okhsl_to_oklab(value: Okhsla) -> Oklaba {
} = value;
let h = h / 360.;

if l == 1. {
if l >= 1. {
return LinearRgba::new(1., 1., 1., alpha).into();
} else if l == 0. {
} else if l <= 0. {
return LinearRgba::new(0., 0., 0., alpha).into();
}

Expand Down Expand Up @@ -407,9 +423,25 @@ pub(crate) fn oklab_to_okhsv(value: Oklaba) -> Okhsva {
b: lab_b,
alpha,
} = value;
let C = ops::sqrt(lab_a * lab_a + lab_b * lab_b);
// Patch: Fixes NaN for pure black and white colors.
if C < f32::EPSILON {
if lab_l >= 1.0 {
return Okhsva {
hue: 0.0,
saturation: 0.0,
value: 1.0,
alpha,
};
}
if lab_l <= 0.0 {
return Okhsva {
hue: 0.0,
saturation: 0.0,
value: 0.0,
alpha,
};
}
let C = ops::sqrt(lab_a * lab_a + lab_b * lab_b);
if C == 0. {
// In this case, value is equal to lightness.
let l = toe(lab_l);
return Okhsva {
Expand Down Expand Up @@ -472,7 +504,7 @@ pub(crate) fn okhsv_to_oklab(value: Okhsva) -> Oklaba {
} = value;
let h = h / 360.;

if v == 0. {
if v <= 0. {
return LinearRgba::new(0., 0., 0., alpha).into();
}

Expand Down
45 changes: 45 additions & 0 deletions crates/bevy_color/src/okhsla.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,51 @@ mod tests {
color_difference::EuclideanDistance, test_colors::TEST_COLORS, testing::assert_approx_eq,
};

#[test]
fn test_from_to_oklaba() {
// Test `oklab_l == 0.0`
let oklaba = Oklaba::new(0.0, 0.5, 0.5, 1.0);
let okhsla: Okhsla = oklaba.into();
let oklaba2: Oklaba = okhsla.into();
assert_approx_eq!(okhsla.hue, 0.0, 0.001);
assert_approx_eq!(okhsla.saturation, 0.0, 0.001);
assert_approx_eq!(okhsla.lightness, 0.0, 0.001);
assert_approx_eq!(okhsla.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);

// Test `oklab_l == 1.0`
let oklaba = Oklaba::new(1.0, 0.5, 0.5, 1.0);
let okhsla: Okhsla = oklaba.into();
let oklaba2: Oklaba = okhsla.into();
assert_approx_eq!(okhsla.hue, 0.0, 0.001);
assert_approx_eq!(okhsla.saturation, 0.0, 0.001);
assert_approx_eq!(okhsla.lightness, 1.0, 0.001);
assert_approx_eq!(okhsla.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);

// Test `oklab_a == 0.0 && oklab_b ==0.0` (C == 0.0)
let oklaba = Oklaba::new(0.5, 0.0, 0.0, 1.0);
let okhsla: Okhsla = oklaba.into();
let oklaba2: Oklaba = okhsla.into();
assert_approx_eq!(okhsla.hue, 0.0, 0.001);
assert_approx_eq!(okhsla.saturation, 0.0, 0.001);
assert_approx_eq!(okhsla.lightness, 0.42114055, 0.001);
assert_approx_eq!(okhsla.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);
}

#[test]
fn test_to_from_srgba() {
let okhsla = Okhsla::new(180.0, 0.5, 0.5, 1.0);
Expand Down
45 changes: 45 additions & 0 deletions crates/bevy_color/src/okhsva.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,51 @@ mod tests {
color_difference::EuclideanDistance, test_colors::TEST_COLORS, testing::assert_approx_eq,
};

#[test]
fn test_from_oklaba() {
// Test `oklab_l == 0.0`
let oklaba = Oklaba::new(0.0, 0.5, 0.5, 1.0);
let okhsva: Okhsva = oklaba.into();
let oklaba2: Oklaba = okhsva.into();
assert_approx_eq!(okhsva.hue, 0.0, 0.001);
assert_approx_eq!(okhsva.saturation, 0.0, 0.001);
assert_approx_eq!(okhsva.value, 0.0, 0.001);
assert_approx_eq!(okhsva.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);

// Test `oklab_l == 1.0`
let oklaba = Oklaba::new(1.0, 0.5, 0.5, 1.0);
let okhsva: Okhsva = oklaba.into();
let oklaba2: Oklaba = okhsva.into();
assert_approx_eq!(okhsva.hue, 0.0, 0.001);
assert_approx_eq!(okhsva.saturation, 0.0, 0.001);
assert_approx_eq!(okhsva.value, 1.0, 0.001);
assert_approx_eq!(okhsva.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);

// Test `oklab_a == 0.0 && oklab_b ==0.0` (C == 0.0)
let oklaba = Oklaba::new(0.5, 0.0, 0.0, 1.0);
let okhsva: Okhsva = oklaba.into();
let oklaba2: Oklaba = okhsva.into();
assert_approx_eq!(okhsva.hue, 0.0, 0.001);
assert_approx_eq!(okhsva.saturation, 0.0, 0.001);
assert_approx_eq!(okhsva.value, 0.42114055, 0.001);
assert_approx_eq!(okhsva.alpha, 1.0, 0.001);

assert_approx_eq!(oklaba.lightness, oklaba2.lightness, 0.001);
assert_approx_eq!(0.0, oklaba2.a, 0.001);
assert_approx_eq!(0.0, oklaba2.b, 0.001);
assert_approx_eq!(oklaba.alpha, oklaba2.alpha, 0.001);
}

#[test]
fn test_to_from_srgba() {
let okhsva = Okhsva::new(180.0, 0.5, 0.5, 1.0);
Expand Down
33 changes: 33 additions & 0 deletions crates/bevy_color/src/test_colors.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![cfg_attr(rustfmt, rustfmt::skip)]
// Generated by gen_tests. Do not edit.
#[cfg(test)]
use crate::{
Expand Down Expand Up @@ -40,6 +41,38 @@ pub const TEST_COLORS: &[TestColor] = &[
okhsl: Okhsla::new(0.0, 0.0, 0.0, 1.0),
okhsv: Okhsva::new(0.0, 0.0, 0.0, 1.0),
},
// black_plus_epsilon
TestColor {
name: "black_plus_epsilon",
rgb: Srgba::new(0.0, 0.0, 0.0000002, 1.0),
linear_rgb: LinearRgba::new(0.0, 0.0, 0.000000015479877, 1.0),
hsl: Hsla::new(240.0, 1.0, 0.0000001, 1.0),
hsv: Hsva::new(240.0, 1.0, 0.0000002, 1.0),
hwb: Hwba::new(240.0, 0.0, 0.9999998, 1.0),
lab: Laba::new(0.000000019073486, 0.000000074505806, -0.00000017881393, 1.0),
lch: Lcha::new(0.000000019073486, 0.0000001937151, 292.61987, 1.0),
oklab: Oklaba::new(0.0011265249, -0.00008089037, -0.00077640166, 1.0),
oklch: Oklcha::new(0.0011265249, 0.00078060414, 264.05203, 1.0),
xyz: Xyza::new(0.0000000027931504, 0.0000000011172602, 0.00000001471059, 1.0),
okhsl: Okhsla::new(264.05203, 0.9999977, 0.00019314568, 1.0),
okhsv: Okhsva::new(264.05203, 0.9999911, 0.00049864844, 1.0),
},
// white_minus_epsilon
TestColor {
name: "white_minus_epsilon",
rgb: Srgba::new(1.0, 1.0, 0.9999998, 1.0),
linear_rgb: LinearRgba::new(1.0, 1.0, 0.9999996, 1.0),
hsl: Hsla::new(60.0, 0.75, 0.9999999, 1.0),
hsv: Hsva::new(60.0, 0.00000017881393, 1.0, 1.0),
hwb: Hwba::new(60.0, 0.9999998, 0.0, 1.0),
lab: Laba::new(1.0, 0.0, 0.00000023841858, 1.0),
lch: Lcha::new(1.0, 0.00000023841858, 90.0, 1.0),
oklab: Oklaba::new(1.0, -0.000000029802322, 0.00000011920929, 1.0),
oklch: Oklcha::new(1.0, 0.00000012287812, 104.03625, 1.0),
xyz: Xyza::new(0.95047, 1.0, 1.0888295, 1.0),
okhsl: Okhsla::new(0.0, 0.0, 1.0, 1.0),
okhsv: Okhsva::new(0.0, 0.0, 1.0, 1.0),
},
// white
TestColor {
name: "white",
Expand Down
4 changes: 4 additions & 0 deletions crates/bevy_color/src/testing.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#[cfg(test)]
macro_rules! assert_approx_eq {
($x:expr, $y:expr, $d:expr) => {
assert!(!f32::is_nan($x));
assert!(!f32::is_nan($y));
if ($x - $y).abs() >= $d {
panic!(
"assertion failed: `(left !== right)` \
Expand All @@ -11,6 +13,8 @@ macro_rules! assert_approx_eq {
};

($x:expr, $y:expr, $d:expr, $msg:expr) => {
assert!(!f32::is_nan($x));
assert!(!f32::is_nan($y));
if ($x - $y).abs() >= $d {
panic!(
"assertion failed: `(left !== right)` \
Expand Down