imagine 0.5.3

A crate to help with images.
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

use crate::borrowed_bitmap::*;
use pixel_formats::r8g8b8a8_Srgb;

/// An owned direct-color image.
///
/// The fields are public, but if you put them together weirdly the methods of
/// this type might panic.
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg(feature = "alloc")]
#[cfg_attr(docs_rs, doc(cfg(feature = "alloc")))]
pub struct Bitmap<P = r8g8b8a8_Srgb> {
  /// width in pixels
  pub width: u32,
  /// height in pixels
  pub height: u32,
  /// pixel values
  pub pixels: alloc::vec::Vec<P>,
}
#[cfg(feature = "alloc")]
#[cfg_attr(docs_rs, doc(cfg(feature = "alloc")))]
impl<P> Bitmap<P> {
  /// Gets the pixel at the position, or `None` if the position is out of
  /// bounds.
  #[inline]
  #[must_use]
  pub fn get_mut(&mut self, x: u32, y: u32) -> Option<&mut P> {
    if x < self.width && y < self.height {
      let i = xy_width_to_index(x, y, self.width);
      self.pixels.get_mut(i)
    } else {
      None
    }
  }
  /// Flips the image top to bottom.
  #[inline]
  pub fn vertical_flip(&mut self) {
    BorrowedBitmap { width: self.width, height: self.height, pixels: &mut self.pixels }
      .vertical_flip()
  }
}

/// An indexed-color image.
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg(feature = "alloc")]
#[cfg_attr(docs_rs, doc(cfg(feature = "alloc")))]
pub struct Palmap<I = u8, P = r8g8b8a8_Srgb> {
  /// width in pixels.
  pub width: u32,
  /// height in pixels
  pub height: u32,
  /// index values for each pixel
  pub indexes: alloc::vec::Vec<I>,
  /// color palette values
  pub palette: alloc::vec::Vec<P>,
}
#[cfg(feature = "alloc")]
#[cfg_attr(docs_rs, doc(cfg(feature = "alloc")))]
impl<I, P> Palmap<I, P> {
  /// Gets the index at the position, or `None` if the position is out of
  /// bounds.
  #[inline]
  #[must_use]
  pub fn get_mut(&mut self, x: u32, y: u32) -> Option<&mut I> {
    if x < self.width && y < self.height {
      let i = xy_width_to_index(x, y, self.width);
      Some(&mut self.indexes[i])
    } else {
      None
    }
  }
  /// Flips the image top to bottom.
  #[inline]
  pub fn vertical_flip(&mut self) {
    BorrowedBitmap { width: self.width, height: self.height, pixels: &mut self.indexes }
      .vertical_flip()
  }
}

impl<I, PxIn, PxOut> From<&Palmap<I, PxIn>> for Bitmap<PxOut>
where
  usize: From<I>,
  I: Clone,
  PxOut: From<PxIn>,
  PxIn: Clone + Default,
{
  #[inline]
  fn from(palmap: &Palmap<I, PxIn>) -> Self {
    let pixels: alloc::vec::Vec<PxOut> = palmap
      .indexes
      .iter()
      .cloned()
      .map(|i| PxOut::from(palmap.palette.get(usize::from(i)).cloned().unwrap_or_default()))
      .collect();
    Bitmap { width: palmap.width, height: palmap.height, pixels }
  }
}