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

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

/// Gray [color model].
///
/// The components are *[value]* and optional *[alpha]*.  *Value* ranges from
/// *black* to *white*.  With [sRGB] gamma it is *luma*, but with [linear]
/// gamma it is *relative luminance*.
///
/// [alpha]: ../el/trait.Pixel.html#method.alpha
/// [color model]: ../trait.ColorModel.html
/// [linear]: ../chan/struct.Linear.html
/// [sRGB]: ../chan/struct.Srgb.html
/// [value]: #method.value
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct Gray {}

impl Gray {
    /// Get the *luma* / *relative luminance* component.
    ///
    /// # Example: Get Value
    /// ```
    /// use pix::chan::Ch16;
    /// use pix::gray::{Gray, Gray16};
    ///
    /// let p = Gray16::new(0x4000);
    /// assert_eq!(Gray::value(p), Ch16::new(0x4000));
    /// ```
    pub fn value<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<0>()
    }

    /// Get a mutable reference to the *luma* / *relative luminance* component.
    ///
    /// # Example: Modify Value
    /// ```
    /// use pix::chan::Ch8;
    /// use pix::gray::{Gray, Gray8};
    ///
    /// let mut p = Gray8::new(0x40);
    /// *Gray::value_mut(&mut p) = 0x50.into();
    /// assert_eq!(Gray::value(p), Ch8::new(0x50));
    /// ```
    pub fn value_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<0>()
    }
}

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

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

    /// Convert from *red*, *green*, *blue* and *alpha* components
    fn from_rgba<P>(rgba: PixRgba<P>) -> P
    where
        P: Pixel<Model = Self>,
    {
        const RED_COEF: f32 = 0.212_6;
        const GREEN_COEF: f32 = 0.715_2;
        const BLUE_COEF: f32 = 0.072_2;

        let chan = rgba.channels();
        let red = chan[0].to_f32() * RED_COEF;
        let green = chan[1].to_f32() * GREEN_COEF;
        let blue = chan[2].to_f32() * BLUE_COEF;
        let value = P::Chan::from(red + green + blue);
        let alpha = chan[3];
        P::from_channels(&[value, alpha])
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    #[test]
    fn rgb_to_gray() {
        assert_eq!(
            SGray8::new(0x7B),
            SRgb16::new(0x4321, 0x9085, 0x5543).convert(),
        );
        assert_eq!(
            SGray8::new(0x46),
            SRgb16::new(0x5768, 0x4091, 0x5000).convert(),
        );
    }

    #[test]
    fn gray_to_rgb() {
        assert_eq!(SRgb8::new(0x45, 0x45, 0x45), SGray8::new(0x45).convert());
        assert_eq!(
            SRgb8::new(0xDA, 0xDA, 0xDA),
            SGraya8::new(0xDA, 0x33).convert(),
        );
        assert_eq!(SRgb8::new(0xBA, 0xBA, 0xBA), Gray8::new(0x7D).convert());
    }

    #[test]
    fn matte_to_gray() {
        assert_eq!(SGraya8::new(0xFF, 0xAB), Matte16::new(0xABCD).convert());
        assert_eq!(SGraya8::new(0xFF, 0x98), Matte16::new(0x9876).convert());
    }

    #[test]
    fn gray_to_matte() {
        assert_eq!(Matte16::new(0x9494), SGraya8::new(0x67, 0x94).convert());
        assert_eq!(Matte16::new(0xA2A2), SGraya8::new(0xBA, 0xA2).convert());
        assert_eq!(Matte8::new(0x80), SGraya32::new(0.75, 0.5).convert());
    }
}