pix 0.15.0

Pixel / raster image library
Documentation 
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

// cmy.rs       CMY color model.
//
// Copyright (c) 2020-2024  Douglas P Lau
//
//! [CMY] color model and types.
//!
//! [cmy]: https://en.wikipedia.org/wiki/CMY_color_model
use crate::ColorModel;
use crate::chan::{
    Ch8, Ch16, Ch32, Channel, Linear, Premultiplied, Srgb, Straight,
};
use crate::el::{Pix, PixRgba, Pixel};
use std::ops::Range;

/// [CMY] subtractive [color model].
///
/// The components are *[cyan]*, *[magenta]*, *[yellow]* and optional *[alpha]*.
///
/// [alpha]: ../el/trait.Pixel.html#method.alpha
/// [cmy]: https://en.wikipedia.org/wiki/CMY_color_model
/// [color model]: ../trait.ColorModel.html
/// [cyan]: #method.cyan
/// [magenta]: #method.magenta
/// [yellow]: #method.yellow
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct Cmy {}

impl Cmy {
    /// Get the *cyan* component.
    ///
    /// # Example: Get CMY Cyan
    /// ```
    /// use pix::cmy::{Cmy, Cmy8};
    /// use pix::chan::Ch8;
    ///
    /// let p = Cmy8::new(0x93, 0x80, 0xA0);
    /// assert_eq!(Cmy::cyan(p), Ch8::new(0x93));
    /// ```
    pub fn cyan<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<0>()
    }

    /// Get a mutable reference to the *cyan* component.
    ///
    /// # Example: Modify CMY Cyan
    /// ```
    /// use pix::cmy::{Cmy, Cmy8};
    /// use pix::chan::Ch8;
    ///
    /// let mut p = Cmy8::new(0x88, 0x77, 0x66);
    /// *Cmy::cyan_mut(&mut p) = 0x55.into();
    /// assert_eq!(Cmy::cyan(p), Ch8::new(0x55));
    /// ```
    pub fn cyan_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<0>()
    }

    /// Get the *magenta* component.
    ///
    /// # Example: CMY Magenta
    /// ```
    /// use pix::cmy::{Cmy, Cmy16};
    /// use pix::chan::Ch16;
    ///
    /// let p = Cmy16::new(0x2000, 0x1234, 0x8000);
    /// assert_eq!(Cmy::magenta(p), Ch16::new(0x1234));
    /// ```
    pub fn magenta<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<1>()
    }

    /// Get a mutable reference to the *magenta* component.
    ///
    /// # Example: Modify CMY Magenta
    /// ```
    /// use pix::cmy::{Cmy, Cmy16};
    /// use pix::chan::Ch16;
    ///
    /// let mut p = Cmy16::new(0x2000, 0x1234, 0x8000);
    /// *Cmy::magenta_mut(&mut p) = 0x4321.into();
    /// assert_eq!(Cmy::magenta(p), Ch16::new(0x4321));
    /// ```
    pub fn magenta_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<1>()
    }

    /// Get the *yellow* component.
    ///
    /// # Example: CMY Yellow
    /// ```
    /// use pix::cmy::{Cmy, Cmy32};
    /// use pix::chan::Ch32;
    ///
    /// let p = Cmy32::new(0.25, 0.5, 1.0);
    /// assert_eq!(Cmy::yellow(p), Ch32::new(1.0));
    /// ```
    pub fn yellow<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<2>()
    }

    /// Get a mutable reference to the *yellow* component.
    ///
    /// # Example: Modify CMY Yellow
    /// ```
    /// use pix::cmy::{Cmy, Cmy32};
    /// use pix::chan::Ch32;
    ///
    /// let mut p = Cmy32::new(0.25, 0.5, 1.0);
    /// *Cmy::yellow_mut(&mut p) = Ch32::new(0.75);
    /// assert_eq!(Cmy::yellow(p), Ch32::new(0.75));
    /// ```
    pub fn yellow_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<2>()
    }
}

impl ColorModel for Cmy {
    const CIRCULAR: Range<usize> = 0..0;
    const LINEAR: Range<usize> = 0..3;
    const ALPHA: usize = 3;

    /// Convert into *red*, *green*, *blue* and *alpha* components
    fn into_rgba<P>(p: P) -> PixRgba<P>
    where
        P: Pixel<Model = Self>,
    {
        let red = P::Chan::MAX - Cmy::cyan(p);
        let green = P::Chan::MAX - Cmy::magenta(p);
        let blue = P::Chan::MAX - Cmy::yellow(p);
        PixRgba::<P>::new::<P::Chan>(red, green, blue, p.alpha())
    }

    /// Convert from *red*, *green*, *blue* and *alpha* components
    fn from_rgba<P>(rgba: PixRgba<P>) -> P
    where
        P: Pixel<Model = Self>,
    {
        let chan = rgba.channels();
        let cyan = P::Chan::MAX - chan[0];
        let magenta = P::Chan::MAX - chan[1];
        let yellow = P::Chan::MAX - chan[2];
        let alpha = chan[3];
        P::from_channels(&[cyan, magenta, yellow, alpha])
    }
}

/// [Cmy](struct.Cmy.html) 8-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmy8 = Pix<3, Ch8, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 16-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmy16 = Pix<3, Ch16, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 32-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmy32 = Pix<3, Ch32, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 8-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html)
/// gamma [pixel](../el/trait.Pixel.html) format.
pub type Cmya8 = Pix<4, Ch8, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 16-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html) gamma
/// [pixel](../el/trait.Pixel.html) format.
pub type Cmya16 = Pix<4, Ch16, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 32-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html) gamma
/// [pixel](../el/trait.Pixel.html) format.
pub type Cmya32 = Pix<4, Ch32, Cmy, Straight, Linear>;

/// [Cmy](struct.Cmy.html) 8-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmya8p = Pix<4, Ch8, Cmy, Premultiplied, Linear>;

/// [Cmy](struct.Cmy.html) 16-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmya16p = Pix<4, Ch16, Cmy, Premultiplied, Linear>;

/// [Cmy](struct.Cmy.html) 32-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Cmya32p = Pix<4, Ch32, Cmy, Premultiplied, Linear>;

/// [Cmy](struct.Cmy.html) 8-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmy8 = Pix<3, Ch8, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 16-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmy16 = Pix<3, Ch16, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 32-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmy32 = Pix<3, Ch32, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 8-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya8 = Pix<4, Ch8, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 16-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya16 = Pix<4, Ch16, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 32-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya32 = Pix<4, Ch32, Cmy, Straight, Srgb>;

/// [Cmy](struct.Cmy.html) 8-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya8p = Pix<4, Ch8, Cmy, Premultiplied, Srgb>;

/// [Cmy](struct.Cmy.html) 16-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya16p = Pix<4, Ch16, Cmy, Premultiplied, Srgb>;

/// [Cmy](struct.Cmy.html) 32-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SCmya32p = Pix<4, Ch32, Cmy, Premultiplied, Srgb>;

#[cfg(test)]
mod test {
    use crate::cmy::*;
    use crate::el::Pixel;
    use crate::rgb::*;

    #[test]
    fn cmy_to_rgb() {
        assert_eq!(Rgb8::new(255, 1, 2), Cmy8::new(0, 254, 253).convert());
        assert_eq!(Rgb8::new(255, 255, 0), Cmy32::new(0.0, 0.0, 1.0).convert(),);
        assert_eq!(Rgb8::new(0, 0, 255), Cmy16::new(65535, 65535, 0).convert(),);
    }

    #[test]
    fn rgb_to_cmy() {
        assert_eq!(Cmy8::new(0, 255, 127), Rgb8::new(255, 0, 128).convert());
        assert_eq!(Cmy32::new(1.0, 0.0, 0.0), Rgb8::new(0, 255, 255).convert(),);
        assert_eq!(Cmy16::new(0, 65535, 65535), Rgb8::new(255, 0, 0).convert(),);
    }
}