Struct piano_keyboard::Keyboard2d

pub struct Keyboard2d {
    pub left_white_key: u8,
    pub right_white_key: u8,
    pub width: u16,
    pub height: u16,
    // some fields omitted
}

The returned 2d Keyboard with all calculated elements.

Fields

left_white_key: u8

right_white_key: u8

width: u16

height: u16

Methods

impl Keyboard2d

pub fn iter(&self) -> Iter<Element>

This function is the preferred way to iterate through all elements. The sequence is from left to right alternating keys in order: white,black,white,....,black,white

pub fn white_keys(&self, blind_as_white: bool) -> Vec<Rectangle>

This function allows to retrieve all white key rectangles - with or without blind.

pub fn black_keys(&self) -> Vec<Rectangle>

This function allows to retrieve all black key rectangles.

pub fn is_perfect(&self) -> bool

Is true for a keyboard without compromises on width/gaps. For example: cargo run --example make_png -- --width 811