altered_perception 0.5.0

`struct HSV/Luma/HSL/etc.` for sharing pixels between crates + other pixel manipulations
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

//! Conversion between and use of various color spaces
//!
//! Currently only supports conversion between HSV & RGB; Luma & RGB; HSL & RGB

pub mod color_spaces;
mod tests;

#[cfg(feature = "serde")]
#[macro_use]
extern crate serde;

#[repr(C)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, PartialOrd, Eq, Hash, Ord)]
/// The HSL pixel
///
/// A container for the hue, saturation, and lightness of a certain pixel
///
/// # Examples
///
/// Here is how to create a single pixel
///
/// ```
/// use altered_perception::HSL;
///
/// let pixel = HSL::new(90.0, 0.5, 0.3);
/// ```
pub struct HSL<T> {
    /// Hue (in degrees)
    pub h: T,
    /// Saturation (between 0 and 1)
    pub s: T,
    /// Lightness (between 0 and 1)
    pub l: T,
}

#[repr(C)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, PartialOrd, Eq, Hash, Ord)]
/// The HSV pixel
///
/// A container for the hue, saturation, and value of a certain pixel
///
/// # Examples
///
/// Here is how to create a single pixel
///
/// ```
/// use altered_perception::HSV;
///
/// let pixel = HSV::new(90.0, 0.5, 0.3);
/// ```
pub struct HSV<T> {
    /// Hue (in degrees)
    pub h: T,
    /// Saturation (between 0 and 1)
    pub s: T,
    /// Value (between 0 and 1)
    pub v: T,
}

#[repr(C)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, PartialOrd, Eq, Hash, Ord)]
/// The Luma pixel
///
/// # Example
///
/// Here is how to create a single pixel
///
/// ```
/// use altered_perception::Luma;
///
/// let pixel = Luma::new(167);
/// ```
pub struct Luma<T> {
    pub luminance: T,
}

#[repr(C)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, PartialOrd, Eq, Hash, Ord)]
/// The CMYK pixel
///
/// A container for the cyan, magenta, yellow, and black levels of a single pixel
///
/// # Examples
///
/// Here is how to create a single pixel
///
/// ```
/// use altered_perception::CMYK;
///
/// let pixel = CMYK::new(0.5, 0.5, 0.3, 0.7);
/// ```
pub struct CMYK<T> {
    /// Cyan (between 0 and 1)
    pub c: T,
    /// Magenta (between 0 and 1)
    pub m: T,
    /// Yellow (between 0 and 1)
    pub y: T,
    /// Black (between 0 and 1)
    pub k: T,
}

#[repr(C)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, PartialOrd, Eq, Hash, Ord)]
/// The CMY pixel
///
/// A container for the cyan, magenta, and yellow levels of a single pixel
///
/// # Examples
///
/// Here is how to create a single pixel
///
/// ```
/// use altered_perception::CMY;
///
/// let pixel = CMY::new(0.5, 0.5, 0.3);
/// ```
pub struct CMY<T> {
    /// Cyan (between 0 and 1)
    pub c: T,
    /// Magenta (between 0 and 1)
    pub m: T,
    /// Yellow (between 0 and 1)
    pub y: T,
}