bevy_color/
xyza.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
use crate::{
    impl_componentwise_vector_space, Alpha, ColorToComponents, Gray, LinearRgba, Luminance, Mix,
    StandardColor,
};
use bevy_math::{Vec3, Vec4};
#[cfg(feature = "bevy_reflect")]
use bevy_reflect::prelude::*;

/// [CIE 1931](https://en.wikipedia.org/wiki/CIE_1931_color_space) color space, also known as XYZ, with an alpha channel.
#[doc = include_str!("../docs/conversion.md")]
/// <div>
#[doc = include_str!("../docs/diagrams/model_graph.svg")]
/// </div>
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(PartialEq, Default))]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(
    all(feature = "serialize", feature = "bevy_reflect"),
    reflect(Serialize, Deserialize)
)]
pub struct Xyza {
    /// The x-axis. [0.0, 1.0]
    pub x: f32,
    /// The y-axis, intended to represent luminance. [0.0, 1.0]
    pub y: f32,
    /// The z-axis. [0.0, 1.0]
    pub z: f32,
    /// The alpha channel. [0.0, 1.0]
    pub alpha: f32,
}

impl StandardColor for Xyza {}

impl_componentwise_vector_space!(Xyza, [x, y, z, alpha]);

impl Xyza {
    /// Construct a new [`Xyza`] color from components.
    ///
    /// # Arguments
    ///
    /// * `x` - x-axis. [0.0, 1.0]
    /// * `y` - y-axis. [0.0, 1.0]
    /// * `z` - z-axis. [0.0, 1.0]
    /// * `alpha` - Alpha channel. [0.0, 1.0]
    pub const fn new(x: f32, y: f32, z: f32, alpha: f32) -> Self {
        Self { x, y, z, alpha }
    }

    /// Construct a new [`Xyza`] color from (x, y, z) components, with the default alpha (1.0).
    ///
    /// # Arguments
    ///
    /// * `x` - x-axis. [0.0, 1.0]
    /// * `y` - y-axis. [0.0, 1.0]
    /// * `z` - z-axis. [0.0, 1.0]
    pub const fn xyz(x: f32, y: f32, z: f32) -> Self {
        Self {
            x,
            y,
            z,
            alpha: 1.0,
        }
    }

    /// Return a copy of this color with the 'x' channel set to the given value.
    pub const fn with_x(self, x: f32) -> Self {
        Self { x, ..self }
    }

    /// Return a copy of this color with the 'y' channel set to the given value.
    pub const fn with_y(self, y: f32) -> Self {
        Self { y, ..self }
    }

    /// Return a copy of this color with the 'z' channel set to the given value.
    pub const fn with_z(self, z: f32) -> Self {
        Self { z, ..self }
    }

    /// [D65 White Point](https://en.wikipedia.org/wiki/Illuminant_D65#Definition)
    pub const D65_WHITE: Self = Self::xyz(0.95047, 1.0, 1.08883);
}

impl Default for Xyza {
    fn default() -> Self {
        Self::new(0., 0., 0., 1.)
    }
}

impl Alpha for Xyza {
    #[inline]
    fn with_alpha(&self, alpha: f32) -> Self {
        Self { alpha, ..*self }
    }

    #[inline]
    fn alpha(&self) -> f32 {
        self.alpha
    }

    #[inline]
    fn set_alpha(&mut self, alpha: f32) {
        self.alpha = alpha;
    }
}

impl Luminance for Xyza {
    #[inline]
    fn with_luminance(&self, lightness: f32) -> Self {
        Self {
            y: lightness,
            ..*self
        }
    }

    fn luminance(&self) -> f32 {
        self.y
    }

    fn darker(&self, amount: f32) -> Self {
        Self {
            y: (self.y - amount).clamp(0., 1.),
            ..*self
        }
    }

    fn lighter(&self, amount: f32) -> Self {
        Self {
            y: (self.y + amount).min(1.),
            ..*self
        }
    }
}

impl Mix for Xyza {
    #[inline]
    fn mix(&self, other: &Self, factor: f32) -> Self {
        let n_factor = 1.0 - factor;
        Self {
            x: self.x * n_factor + other.x * factor,
            y: self.y * n_factor + other.y * factor,
            z: self.z * n_factor + other.z * factor,
            alpha: self.alpha * n_factor + other.alpha * factor,
        }
    }
}

impl Gray for Xyza {
    const BLACK: Self = Self::new(0., 0., 0., 1.);
    const WHITE: Self = Self::new(0.95047, 1.0, 1.08883, 1.0);
}

impl ColorToComponents for Xyza {
    fn to_f32_array(self) -> [f32; 4] {
        [self.x, self.y, self.z, self.alpha]
    }

    fn to_f32_array_no_alpha(self) -> [f32; 3] {
        [self.x, self.y, self.z]
    }

    fn to_vec4(self) -> Vec4 {
        Vec4::new(self.x, self.y, self.z, self.alpha)
    }

    fn to_vec3(self) -> Vec3 {
        Vec3::new(self.x, self.y, self.z)
    }

    fn from_f32_array(color: [f32; 4]) -> Self {
        Self {
            x: color[0],
            y: color[1],
            z: color[2],
            alpha: color[3],
        }
    }

    fn from_f32_array_no_alpha(color: [f32; 3]) -> Self {
        Self {
            x: color[0],
            y: color[1],
            z: color[2],
            alpha: 1.0,
        }
    }

    fn from_vec4(color: Vec4) -> Self {
        Self {
            x: color[0],
            y: color[1],
            z: color[2],
            alpha: color[3],
        }
    }

    fn from_vec3(color: Vec3) -> Self {
        Self {
            x: color[0],
            y: color[1],
            z: color[2],
            alpha: 1.0,
        }
    }
}

impl From<LinearRgba> for Xyza {
    fn from(
        LinearRgba {
            red,
            green,
            blue,
            alpha,
        }: LinearRgba,
    ) -> Self {
        // Linear sRGB to XYZ
        // http://www.brucelindbloom.com/index.html?Eqn_XYZ_to_RGB.html
        // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html (sRGB, RGB to XYZ [M])
        let r = red;
        let g = green;
        let b = blue;

        let x = r * 0.4124564 + g * 0.3575761 + b * 0.1804375;
        let y = r * 0.2126729 + g * 0.7151522 + b * 0.072175;
        let z = r * 0.0193339 + g * 0.119192 + b * 0.9503041;

        Xyza::new(x, y, z, alpha)
    }
}

impl From<Xyza> for LinearRgba {
    fn from(Xyza { x, y, z, alpha }: Xyza) -> Self {
        // XYZ to Linear sRGB
        // http://www.brucelindbloom.com/index.html?Eqn_XYZ_to_RGB.html
        // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html (sRGB, XYZ to RGB [M]-1)
        let r = x * 3.2404542 + y * -1.5371385 + z * -0.4985314;
        let g = x * -0.969266 + y * 1.8760108 + z * 0.041556;
        let b = x * 0.0556434 + y * -0.2040259 + z * 1.0572252;

        LinearRgba::new(r, g, b, alpha)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        color_difference::EuclideanDistance, test_colors::TEST_COLORS, testing::assert_approx_eq,
        Srgba,
    };

    #[test]
    fn test_to_from_srgba() {
        let xyza = Xyza::new(0.5, 0.5, 0.5, 1.0);
        let srgba: Srgba = xyza.into();
        let xyza2: Xyza = srgba.into();
        assert_approx_eq!(xyza.x, xyza2.x, 0.001);
        assert_approx_eq!(xyza.y, xyza2.y, 0.001);
        assert_approx_eq!(xyza.z, xyza2.z, 0.001);
        assert_approx_eq!(xyza.alpha, xyza2.alpha, 0.001);
    }

    #[test]
    fn test_to_from_srgba_2() {
        for color in TEST_COLORS.iter() {
            let rgb2: Srgba = (color.xyz).into();
            let xyz2: Xyza = (color.rgb).into();
            assert!(
                color.rgb.distance(&rgb2) < 0.00001,
                "{}: {:?} != {:?}",
                color.name,
                color.rgb,
                rgb2
            );
            assert_approx_eq!(color.xyz.x, xyz2.x, 0.001);
            assert_approx_eq!(color.xyz.y, xyz2.y, 0.001);
            assert_approx_eq!(color.xyz.z, xyz2.z, 0.001);
            assert_approx_eq!(color.xyz.alpha, xyz2.alpha, 0.001);
        }
    }
}