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
//! XYZ colour with transparency representation.
use num_traits::Float;
use std::fmt::{Display, Formatter, Result as FmtResult};
use crate::{
error::{Result, validate_unit_component},
impl_transparent_colour, impl_transparent_convert, impl_transparent_display,
spaces::{Grey, GreyAlpha, Hsl, HslAlpha, Hsv, HsvAlpha, Lab, LabAlpha, Rgb, RgbAlpha, Srgb, SrgbAlpha, Xyz},
traits::{Colour, Convert},
};
/// XYZ with alpha channel.
#[derive(Debug, Clone, Copy)]
pub struct XyzAlpha<T: Float + Send + Sync> {
/// Base colour
colour: Xyz<T>,
/// Alpha component in range [0, 1].
alpha: T,
}
impl<T: Float + Send + Sync> XyzAlpha<T> {
/// Create a new `XyzAlpha` instance.
///
/// # Arguments
///
/// * `x` - The X component, must be in range [0, 1]
/// * `y` - The Y component (luminance), must be in range [0, 1]
/// * `z` - The Z component, must be in range [0, 1]
/// * `alpha` - The alpha (transparency) component, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if any component is outside the range [0, 1].
pub fn new(x: T, y: T, z: T, alpha: T) -> Result<Self> {
validate_unit_component(alpha, "alpha")?;
Ok(Self {
colour: Xyz::new(x, y, z)?,
alpha,
})
}
/// Create a new `XyzAlpha` instance from a `Xyz` colour and an alpha component.
///
/// # Arguments
///
/// * `colour` - The base XYZ colour
/// * `alpha` - The alpha (transparency) component, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if the alpha component is outside the range [0, 1].
fn new_colour_with_alpha(colour: Xyz<T>, alpha: T) -> Result<Self> {
validate_unit_component(alpha, "alpha")?;
Ok(Self { colour, alpha })
}
/// Get the base `colour`.
const fn colour(&self) -> &Xyz<T> {
&self.colour
}
/// Get the `x` component.
pub const fn x(&self) -> T {
self.colour.x()
}
/// Get the `y` component (luminance).
pub const fn y(&self) -> T {
self.colour.y()
}
/// Get the `z` component.
pub const fn z(&self) -> T {
self.colour.z()
}
/// Get the `alpha` component.
pub const fn alpha(&self) -> T {
self.alpha
}
/// Set the `x` component.
///
/// # Arguments
///
/// * `x` - The new X value, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if the value is outside the range [0, 1].
pub fn set_x(&mut self, x: T) -> Result<()> {
self.colour.set_x(x)
}
/// Set the `y` component (luminance).
///
/// # Arguments
///
/// * `y` - The new Y value, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if the value is outside the range [0, 1].
pub fn set_y(&mut self, y: T) -> Result<()> {
self.colour.set_y(y)
}
/// Set the `z` component.
///
/// # Arguments
///
/// * `z` - The new Z value, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if the value is outside the range [0, 1].
pub fn set_z(&mut self, z: T) -> Result<()> {
self.colour.set_z(z)
}
/// Set the `alpha` component.
///
/// # Arguments
///
/// * `alpha` - The new alpha value, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if the value is outside the range [0, 1].
pub fn set_alpha(&mut self, alpha: T) -> Result<()> {
validate_unit_component(alpha, "alpha")?;
self.alpha = alpha;
Ok(())
}
/// Set all components at once with validation.
///
/// # Arguments
///
/// * `x` - The X component, must be in range [0, 1]
/// * `y` - The Y component (luminance), must be in range [0, 1]
/// * `z` - The Z component, must be in range [0, 1]
/// * `alpha` - The alpha component, must be in range [0, 1]
///
/// # Errors
///
/// Returns an error if any component validation fails.
pub fn set_components(&mut self, x: T, y: T, z: T, alpha: T) -> Result<()> {
validate_unit_component(x, "x")?;
validate_unit_component(y, "y")?;
validate_unit_component(z, "z")?;
validate_unit_component(alpha, "alpha")?;
// If all validations pass, update all components
self.colour = Xyz::new(x, y, z)?;
self.alpha = alpha;
Ok(())
}
/// Get XYZ values relative to D65 reference white.
/// Returns (X/Xn, Y/Yn, Z/Zn)
///
/// # Errors
///
/// Returns an error if reference white calculation fails.
pub fn relative_to_white(&self) -> Result<(T, T, T)> {
self.colour.relative_to_white()
}
/// Calculate perceptual colour difference in XYZ space (simple Euclidean distance),
/// ignoring the alpha channel.
/// Note: This is not an ideal colour difference metric - consider using Lab with Delta E metrics for better results.
pub fn distance(&self, other: &Self) -> T {
self.colour.distance(&other.colour)
}
}
impl_transparent_colour!(XyzAlpha<T>, Xyz<T>, 3);
impl_transparent_convert!(XyzAlpha<T>, Xyz<T>);
impl_transparent_display!(XyzAlpha<T>);