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 281 282 283 284 285 286 287 288 289 290
use super::*; /// A trait that abstracts over the specifics of a Launchpad and allows generic access and /// manipulation of a Launchpad's LEDs. /// /// # How do you use a canvas? /// /// [`Canvas`]es work by first accumulating LED changes, and finally flushing all LED state changes /// in an efficient manner by calling `.flush()`. /// /// Every [`Canvas`] maintains two buffers: the unflushed one, and the edited one. Therefore, you /// can access both the unflushed and the buffered state of the button, using `get_old` and `get`, /// respectively. /// /// Example: /// ```rust /// fn light_white(canvas: &mut impl Canvas) -> Result<()> { /// // Iterate through all buttons in the canvas. See the documentation on [`CanvasIterator`] for /// // more info /// for pad in canvas.iter() { /// canvas[pad] = Color::WHITE; /// } /// } /// /// // The above function doesn't take a specific low-level object like Output or /// // Output. Instead it utilizes Canvas, so you can call it with _all_ devices! /// /// // Light a connected Launchpad S and Launchpad Mk2 completely white /// light_white(&mut launchy::s::Canvas::guess()); /// light_white(&mut launchy::mk2::Canvas::guess()); /// ``` pub trait Canvas: std::ops::Index<Pad, Output=Color> + std::ops::IndexMut<Pad, Output=Color> { // These are the methods that _need_ to be implemented by the implementor /// The width of the smallest rectangle that still fully encapsulates the shape of this canvas /// /// ```rust /// let canvas = launchy::mk2::Canvas::guess(|_| {})?; /// /// assert_eq!(canvas.bounding_box_width(), 9); /// ``` fn bounding_box_width(&self) -> u32; /// The height of the smallest rectangle that still fully encapsulates the shape of this canvas /// /// ```rust /// let canvas = launchy::mk2::Canvas::guess(|_| {})?; /// /// assert_eq!(canvas.bounding_box_height(), 9); /// ``` fn bounding_box_height(&self) -> u32; /// Check if the location is in bounds /// /// ```rust /// let canvas = launchy::mk2::Canvas::guess(|_| {})?; /// /// assert!(canvas.is_valid(7, 0)); /// assert!(!canvas.is_valid(8, 0)); /// ``` fn is_valid(&self, x: u32, y: u32) -> bool; /// Returns a reference to the color at the given position. No bounds checking fn get_old_unchecked_ref(&self, x: u32, y: u32) -> &Color; /// Returns a reference to the in-buffer/unflushed color at the given position. No bounds /// checking fn get_new_unchecked_ref(&self, x: u32, y: u32) -> &Color; /// Returns a mutable reference to the color at the given position. No bounds checking fn get_new_unchecked_mut(&mut self, x: u32, y: u32) -> &mut Color; /// Flush the accumulated changes to the underlying device /// /// ```rust /// let mut canvas = launchy::mk2::Canvas::guess(|_| {})?; /// /// canvas[Pad { x: 0, y: 0 }] = Color::RED; /// canvas[Pad { x: 1, y: 0 }] = Color::GREEN; /// canvas[Pad { x: 2, y: 0 }] = Color::RED; /// canvas[Pad { x: 3, y: 0 }] = Color::GREEN; /// /// // The changes are only transmitted when they are flushed /// canvas.flush()?; /// ``` fn flush(&mut self) -> Result<(), crate::MidiError>; /// The lowest visible brightness on this canvas. Used to calibrate brightness across /// Launchpads; users of the library probably don't need to worry about this fn lowest_visible_brightness(&self) -> f32; // These are defaut implementations that you get for free /// Returns the currently displayed color at the given position, or None if out of bounds /// /// ```rust /// let canvas = launchy::mk2::Canvas::guess(|_| {})?; /// /// assert_eq!(canvas.get(Pad { x: 5, y: 5 }), Some(Color::BLACK)); /// /// canvas[Pad { x: 5, y: 5 }] = Color::RED; /// assert_eq!(canvas.get(Pad { x: 5, y: 5 }), Some(Color::BLACK)); /// /// canvas.flush()?; /// assert_eq!(canvas.get(Pad { x: 5, y: 5 }), Some(Color::RED)); /// ``` fn get(&self, pad: Pad) -> Option<Color> { if pad.x >= 0 && pad.y >= 0 && self.is_valid(pad.x as u32, pad.y as u32) { Some(*self.get_old_unchecked_ref(pad.x as u32, pad.y as u32)) } else { None } } /// Returns the color at the given position. No bounds checking fn get_old_unchecked(&self, x: u32, y: u32) -> Color { *self.get_old_unchecked_ref(x, y) } /// Returns the in-buffer/unflushed color at the given position. No bounds checking fn get_new_unchecked(&self, x: u32, y: u32) -> Color { *self.get_new_unchecked_ref(x, y) } /// Set the color at the given position. No bounds checking fn set_unchecked(&mut self, x: u32, y: u32, color: Color) { *self.get_new_unchecked_mut(x, y) = color; } /// Returns a reference to the color at the given position, or None if out of bounds fn get_ref(&self, pad: Pad) -> Option<&Color> { if pad.x >= 0 && pad.y >= 0 && self.is_valid(pad.x as u32, pad.y as u32) { Some(self.get_old_unchecked_ref(pad.x as u32, pad.y as u32)) } else { None } } /// Returns a mutable reference to the color at the given position, or None if out of bounds fn get_mut(&mut self, pad: Pad) -> Option<&mut Color> { if pad.x >= 0 && pad.y >= 0 && self.is_valid(pad.x as u32, pad.y as u32) { Some(self.get_new_unchecked_mut(pad.x as u32, pad.y as u32)) } else { None } } /// Returns the old, unflushed color at the given location, or None if out of bounds fn get_new(&self, pad: Pad) -> Option<Color> { if pad.x >= 0 && pad.y >= 0 && self.is_valid(pad.x as u32, pad.y as u32) { Some(*self.get_new_unchecked_ref(pad.x as u32, pad.y as u32)) } else { None } } /// Returns the old, unflushed color at the given location. Panics if out of bounds fn at_new(&self, pad: Pad) -> Color { self.get_new(pad).expect("Pad coordinates out of bounds") } /// Sets the color at the given position. Returns None if out of bounds #[must_use] fn set(&mut self, pad: Pad, color: Color) -> Option<()> { *self.get_mut(pad)? = color; Some(()) } /// An iterator over the buttons of a given Canvas. Create an iterator by calling `.iter()` on a /// [`Canvas`]. /// /// This iterator returns [`Pad`]s, which are a view on a single button on the canvas. See /// the documentation on [`Pad`] for more information. /// /// For example to light the entire canvas white: /// ```rust /// for pad in canvas.iter() { /// canvas[pad] = Color::WHITE; /// } /// canvas.flush()?; /// ``` /// /// Or, if you want to move the entire contents of the canvas one pixel to the right: /// ```rust /// for pad in canvas.iter() { /// // If there's a pad to the left /// if let Some(color) = canvas[pad.left(1)] { /// // Move the color of the left pad to this pad /// canvas[pad] = color; /// } /// } /// canvas.flush()?; /// ``` fn iter(&self) -> CanvasIterator { return CanvasIterator::new(self); } /// Toggles the button at the specified coordinate with the given color. /// /// Light the specified button with the given color, except if the button is already lit with /// that color; in which case the button is turned off. /// /// For example, if you were to make a paint program for the Launchpad MK2 where you can toggle /// pixels by pressing: /// ```rust /// let mut (canvas, poller) = launchy::mk2::Canvas::guess(); /// /// for msg in poller.iter() { /// if let CanvasMessage::Press { x, y } = msg { /// canvas.toggle(x, y, Color::WHITE); /// canvas.flush()?; /// } /// } /// ``` fn toggle(&mut self, pad: Pad, color: Color) -> Option<()> { if self.get(pad)? == color { self.set(pad, Color::BLACK)?; } else { self.set(pad, color)?; } Some(()) } /// Clear the entire canvas by setting all buttons to black. /// /// ```rust /// // light a square in the top left, for one second /// /// canvas.set(0, 0, Color::MAGENTA); /// canvas.set(0, 1, Color::MAGENTA); /// canvas.set(1, 0, Color::MAGENTA); /// canvas.set(1, 1, Color::MAGENTA); /// /// std::thread::sleep_ms(1000); /// /// canvas.clear(); /// canvas.flush()?; /// ``` fn clear(&mut self) where Self: Sized { for pad in self.iter() { self[pad] = Color::BLACK; } } fn into_padded(self) -> PaddingCanvas<Self> where Self: Sized { PaddingCanvas::from(self) } } #[derive(Clone, Eq, PartialEq, Hash, Debug)] pub enum CanvasMessage { Press { x: u32, y: u32 }, Release { x: u32, y: u32 }, } impl CanvasMessage { /// Retrieves the x coordinate of this message, no matter if this is a press or a release /// message pub fn x(&self) -> u32 { match *self { Self::Press { x, y: _ } => x, Self::Release { x, y: _ } => x, } } /// Retrieves the y coordinate of this message, no matter if this is a press or a release /// message pub fn y(&self) -> u32 { match *self { Self::Press { x: _, y } => y, Self::Release { x: _, y } => y, } } pub fn pad(&self) -> Pad { Pad { x: self.x() as i32, y: self.y() as i32 } } /// Returns whether this is a press message pub fn is_press(&self) -> bool { match self { Self::Press { .. } => true, _ => false, } } /// Returns whether this is a release message pub fn is_release(&self) -> bool { match self { Self::Release { .. } => true, _ => false, } } }