Skip to main content

KeyswitchInfo

Struct KeyswitchInfo 

Source
pub struct KeyswitchInfo {
    pub type_id: u32,
    pub title: [u8; 64],
    pub title_len: u8,
    pub short_title: [u8; 64],
    pub short_title_len: u8,
    pub keyswitch_min: i32,
    pub keyswitch_max: i32,
    pub key_remapped: i32,
    pub unit_id: i32,
    pub flags: i32,
}
Expand description

Information about a keyswitch (articulation).

Used by sample libraries and orchestral instruments to describe available articulation switches.

Fields§

§type_id: u32

Keyswitch type (see keyswitch_type module).

§title: [u8; 64]

Display title (e.g., “Staccato”, “Legato”).

§title_len: u8

Title length.

§short_title: [u8; 64]

Short title (e.g., “Stac”, “Leg”).

§short_title_len: u8

Short title length.

§keyswitch_min: i32

Minimum key in the keyswitch range (MIDI note 0-127).

§keyswitch_max: i32

Maximum key in the keyswitch range (MIDI note 0-127).

§key_remapped: i32

Remapped key (-1 if not remapped).

§unit_id: i32

Unit ID for grouping (-1 for none).

§flags: i32

Flags (reserved for future use).

Implementations§

Source§

impl KeyswitchInfo

Source

pub fn new(type_id: u32, title: &str, key: i32) -> Self

Create a new keyswitch info for a single key.

Source

pub fn key_range(type_id: u32, title: &str, min_key: i32, max_key: i32) -> Self

Create a keyswitch for a range of keys.

Source

pub fn set_title(&mut self, title: &str)

Set the title.

Source

pub fn set_short_title(&mut self, short_title: &str)

Set the short title.

Source

pub fn title_str(&self) -> &str

Get the title as a string slice.

Source

pub fn short_title_str(&self) -> &str

Get the short title as a string slice.

Source

pub fn with_short_title(self, short_title: &str) -> Self

Builder: set short title.

Source

pub fn with_key_remapped(self, key: i32) -> Self

Builder: set remapped key.

Trait Implementations§

Source§

impl Clone for KeyswitchInfo

Source§

fn clone(&self) -> KeyswitchInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyswitchInfo

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for KeyswitchInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for KeyswitchInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.