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
// bgr.rs BGR color model.
//
// Copyright (c) 2020 Douglas P Lau
//
//! BGR color model and types.
use crate::chan::{Ch16, Ch32, Ch8, Linear, Premultiplied, Srgb, Straight};
use crate::el::{Pix3, Pix4, PixRgba, Pixel};
use crate::ColorModel;
use std::ops::Range;
/// BGR arrangement of [RGB] [color model].
///
/// The components are *[blue]*, *[green]*, *[red]* and optional *[alpha]*.
///
/// [alpha]: ../el/trait.Pixel.html#method.alpha
/// [blue]: #method.blue
/// [color model]: ../trait.ColorModel.html
/// [green]: #method.green
/// [red]: #method.red
/// [rgb]: ../rgb/struct.Rgb.html
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct Bgr {}
impl Bgr {
/// Get the *blue* component.
///
/// # Example: Get BGR Blue
/// ```
/// use pix::bgr::{Bgr, Bgr8};
/// use pix::chan::Ch8;
///
/// let p = Bgr8::new(0x93, 0x80, 0xA0);
/// assert_eq!(Bgr::blue(p), Ch8::new(0x93));
/// ```
pub fn blue<P: Pixel>(p: P) -> P::Chan
where
P: Pixel<Model = Self>,
{
p.one()
}
/// Get a mutable reference to the *blue* component.
///
/// # Example: Modify BGR Blue
/// ```
/// use pix::bgr::{Bgr, Bgr8};
/// use pix::chan::Ch8;
///
/// let mut p = Bgr8::new(0x88, 0x77, 0x66);
/// *Bgr::blue_mut(&mut p) = 0x55.into();
/// assert_eq!(Bgr::blue(p), Ch8::new(0x55));
/// ```
pub fn blue_mut<P: Pixel>(p: &mut P) -> &mut P::Chan
where
P: Pixel<Model = Self>,
{
p.one_mut()
}
/// Get the *green* component.
///
/// # Example: BGR Green
/// ```
/// use pix::bgr::{Bgr, Bgr16};
/// use pix::chan::Ch16;
///
/// let p = Bgr16::new(0x2000, 0x1234, 0x8000);
/// assert_eq!(Bgr::green(p), Ch16::new(0x1234));
/// ```
pub fn green<P: Pixel>(p: P) -> P::Chan
where
P: Pixel<Model = Self>,
{
p.two()
}
/// Get a mutable reference to the *green* component.
///
/// # Example: Modify BGR Green
/// ```
/// use pix::bgr::{Bgr, Bgr16};
/// use pix::chan::Ch16;
///
/// let mut p = Bgr16::new(0x2000, 0x1234, 0x8000);
/// *Bgr::green_mut(&mut p) = 0x4321.into();
/// assert_eq!(Bgr::green(p), Ch16::new(0x4321));
/// ```
pub fn green_mut<P: Pixel>(p: &mut P) -> &mut P::Chan
where
P: Pixel<Model = Self>,
{
p.two_mut()
}
/// Get the *red* component.
///
/// # Example: BGR Red
/// ```
/// use pix::bgr::{Bgr, Bgr32};
/// use pix::chan::Ch32;
///
/// let p = Bgr32::new(0.25, 0.5, 1.0);
/// assert_eq!(Bgr::red(p), Ch32::new(1.0));
/// ```
pub fn red<P: Pixel>(p: P) -> P::Chan
where
P: Pixel<Model = Self>,
{
p.three()
}
/// Get a mutable reference to the *red* component.
///
/// # Example: Modify BGR Red
/// ```
/// use pix::bgr::{Bgr, Bgr32};
/// use pix::chan::Ch32;
///
/// let mut p = Bgr32::new(0.25, 0.5, 1.0);
/// *Bgr::red_mut(&mut p) = Ch32::new(0.75);
/// assert_eq!(Bgr::red(p), Ch32::new(0.75));
/// ```
pub fn red_mut<P: Pixel>(p: &mut P) -> &mut P::Chan
where
P: Pixel<Model = Self>,
{
p.three_mut()
}
}
impl ColorModel for Bgr {
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 = Bgr::red(p);
let green = Bgr::green(p);
let blue = Bgr::blue(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 red = chan[0];
let green = chan[1];
let blue = chan[2];
let alpha = chan[3];
P::from_channels(&[blue, green, red, alpha])
}
}
/// [Bgr](struct.Bgr.html) 8-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgr8 = Pix3<Ch8, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 16-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgr16 = Pix3<Ch16, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 32-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgr32 = Pix3<Ch32, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 8-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html)
/// gamma [pixel](../el/trait.Pixel.html) format.
pub type Bgra8 = Pix4<Ch8, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 16-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html) gamma
/// [pixel](../el/trait.Pixel.html) format.
pub type Bgra16 = Pix4<Ch16, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 32-bit [straight](../chan/struct.Straight.html)
/// alpha [linear](../chan/struct.Linear.html) gamma
/// [pixel](../el/trait.Pixel.html) format.
pub type Bgra32 = Pix4<Ch32, Bgr, Straight, Linear>;
/// [Bgr](struct.Bgr.html) 8-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgra8p = Pix4<Ch8, Bgr, Premultiplied, Linear>;
/// [Bgr](struct.Bgr.html) 16-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgra16p = Pix4<Ch16, Bgr, Premultiplied, Linear>;
/// [Bgr](struct.Bgr.html) 32-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Bgra32p = Pix4<Ch32, Bgr, Premultiplied, Linear>;
/// [Bgr](struct.Bgr.html) 8-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgr8 = Pix3<Ch8, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 16-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgr16 = Pix3<Ch16, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 32-bit opaque (no *alpha* channel)
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgr32 = Pix3<Ch32, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 8-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra8 = Pix4<Ch8, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 16-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra16 = Pix4<Ch16, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 32-bit [straight](../chan/struct.Straight.html)
/// alpha [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra32 = Pix4<Ch32, Bgr, Straight, Srgb>;
/// [Bgr](struct.Bgr.html) 8-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra8p = Pix4<Ch8, Bgr, Premultiplied, Srgb>;
/// [Bgr](struct.Bgr.html) 16-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra16p = Pix4<Ch16, Bgr, Premultiplied, Srgb>;
/// [Bgr](struct.Bgr.html) 32-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type SBgra32p = Pix4<Ch32, Bgr, Premultiplied, Srgb>;