Struct launchy::DeviceCanvas

pub struct DeviceCanvas<Spec: DeviceSpec> { /* private fields */ }

A generic Canvas implementation for all launchpads, that relies on a DeviceSpec. You as a user of the library don’t need to access this struct directly. Use the “Canvas” type aliases that each launchpad module provides, for example launchy::mk2::Canvas or launchy::s::Canvas.

Implementations

impl<Spec: DeviceSpec> DeviceCanvas<Spec>

pub fn guess( callback: impl FnMut(CanvasMessage) + Send + 'static ) -> Result<Self, MidiError>

Create a new canvas by guessing both input and output MIDI connection by their name. If you need precise control over the specific MIDI connections that will be used, use [DeviceCanvas::from_ports] instead // TODO: not implemented yet

pub fn guess_polling() -> Result<(Self, DeviceCanvasPoller), MidiError>

Trait Implementations

impl<Spec: DeviceSpec> Canvas for DeviceCanvas<Spec>

fn bounding_box(&self) -> (u32, u32)

The width and height of the smallest rectangle that still fully encapsulates the shape of this canvas

fn lowest_visible_brightness(&self) -> f32

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 low_level_get(&self, x: u32, y: u32) -> Option<&Color>

Returns a reference to the currently displayed color at the given position

fn low_level_get_pending_mut(&mut self, x: u32, y: u32) -> Option<&mut Color>

Returns a mutable reference to the in-buffer/unflushed color at the given position

fn low_level_get_pending(&self, x: u32, y: u32) -> Option<&Color>

Returns a reference to the in-buffer/unflushed color at the given position

fn flush(&mut self) -> Result<(), MidiError>

Flush the accumulated changes to the underlying device

fn get(&self, pad: Pad) -> Option<Color>

Returns the currently displayed color at the given position, or None if out of bounds

fn get_pending(&self, pad: Pad) -> Option<Color>

Returns the buffered/unflushed color at the given position, or None if out of bounds

fn set(&mut self, pad: Pad, color: Color) -> Option<()>

Sets the color at the given position. Returns None if out of bounds

fn iter(&self) -> CanvasIterator

An iterator over the buttons of a given Canvas. Create an iterator by calling .iter() on a Canvas.

fn toggle(&mut self, pad: Pad, color: Color) -> Option<()>

Toggles the button at the specified coordinate with the given color.

fn clear(&mut self)where Self: Sized,

Clear the entire canvas by setting all buttons to black.

fn into_padded(self) -> PaddingCanvas<Self>where Self: Sized,

See PaddingCanvas for more details

fn is_valid(&self, pad: Pad) -> bool

impl<S: DeviceSpec> Index<Pad> for DeviceCanvas<S>

type Output = Color

The returned type after indexing.

fn index(&self, pad: Pad) -> &Color

Performs the indexing (container[index]) operation.

impl<S: DeviceSpec> IndexMut<Pad> for DeviceCanvas<S>

fn index_mut(&mut self, pad: Pad) -> &mut Color

Performs the mutable indexing (container[index]) operation.