launchy 0.1.0

Low-level bindings and high-level abstractions for the Novation Launchpad MIDI devices
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

use super::*;
use crate::util::Array2d;

/// A canvas wrapper that fills holes and other irregularities to provide a perfectly rectangular
/// grid.
/// 
/// Launchpads traditionally have non-rectangular shapes:
/// - Most Launchpads are _almost_ 9x9 - just one pixel is missing
/// - The Launchpad Pro is _almost_ 10x10, except each corner has a pixel missing
/// - The Launch Control has an even _more_ irregular placement if the four control buttons are
/// 	included
/// 
/// Or, even worse, when having a multi-Launchpad setup using CanvasLayout - that's even less
/// rectangular; there will be gaps and empty spaces all over the place.
/// 
/// Sometimes it's a pain to deal with those irregular shapes. For that reason, this struct provides
/// a [`Canvas`] wrapper that inserts 'virtual pixels' into all the gaps so that you can work with the
/// Launchpad as if it were a perfectly rectangular grid.
/// 
/// Example:
/// ```rust
/// // Create the base canvas
/// let mut canvas = launchy::mk2::Canvas::guess(|msg| {});
/// 
/// // Wrap the holey canvas in `PaddingCanvas`
/// let mut canvas = launchy::PaddingCanvas::from(canvas);
/// 
/// // Now you can fearlessly work with the canvas as if it's a rectangle
/// for y in 0..9 {
/// 	for x in 0..9 {
/// 		canvas.set(x, y, launchy::Color::WHITE);
/// 	}
/// }
/// ```
pub struct PaddingCanvas<C: Canvas> {
	inner: C,
	curr_buf: Array2d<Color>,
	new_buf: Array2d<Color>,
}

impl<C: Canvas> PaddingCanvas<C> {
	/// Wrap the given canvas in a PaddingCanvas
	pub fn from(inner: C) -> Self {
		let width = inner.bounding_box_width() as usize;
		let height = inner.bounding_box_height() as usize;

		Self {
			inner,
			curr_buf: Array2d::new(width, height),
			new_buf: Array2d::new(width, height),
		}
	}
}

impl<C: Canvas> Canvas for PaddingCanvas<C> {
    fn bounding_box_width(&self) -> u32 { self.inner.bounding_box_width() }
	fn bounding_box_height(&self) -> u32 { self.inner.bounding_box_height() }
	fn lowest_visible_brightness(&self) -> f32 { self.inner.lowest_visible_brightness() }
	
    fn is_valid(&self, x: u32, y: u32) -> bool {
        x < self.bounding_box_width() && y < self.bounding_box_height()
	}
	
    fn get_old_unchecked_ref(&self, x: u32, y: u32) -> &Color {
        if self.inner.is_valid(x, y) {
			self.inner.get_old_unchecked_ref(x, y)
		} else {
			self.curr_buf.get_ref(x as usize, y as usize)
		}
	}
	
    fn get_new_unchecked_ref(&self, x: u32, y: u32) -> &Color {
        if self.inner.is_valid(x, y) {
			self.inner.get_new_unchecked_ref(x, y)
		} else {
			self.new_buf.get_ref(x as usize, y as usize)
		}
	}

    fn get_new_unchecked_mut(&mut self, x: u32, y: u32) -> &mut Color {
        if self.inner.is_valid(x, y) {
			self.inner.get_new_unchecked_mut(x, y)
		} else {
			self.new_buf.get_mut(x as usize, y as usize)
		}
	}
	
    fn flush(&mut self) -> Result<(), crate::MidiError> {
		self.curr_buf = self.new_buf.clone();
		self.inner.flush()
    }
}

impl_traits_for_canvas!(<C: Canvas>, PaddingCanvas);