Struct PitchBend

pub struct PitchBend { /* private fields */ }

The value of a pitch bend, represented as 14 bits.

A value of 0x0000 indicates full bend downwards. A value of 0x2000 indicates no bend. A value of 0x3FFF indicates full bend upwards.

This value is available via PitchBend::value

Implementations

impl PitchBend

pub fn new(lsb: u8, msb: u8) -> Result<Self, Error>

Creates a new pitch bend given the least significant and most significant bytes.

Checks for byte correctness (leading 0 bit)

pub const fn new_unchecked(lsb: u8, msb: u8) -> Self

Creates a new pitch bend given the least significant and most significant bytes.

Does not check for correctness

pub fn lsb(&self) -> u8

Returns a reference to the pitch bend’s least significant byte.

pub fn msb(&self) -> u8

Returns a reference to the pitch bend’s most significant byte.

pub fn value(&self) -> u16

Represents a pitch bend

pub fn from_bits(rep: u16) -> Result<Self, Error>

Represents a u16, lsb then msb, as a pitch bend

impl PitchBend

pub const MIN_BYTES: u16 = 0u16

The minimum value of 0x0000, indicating full bend downwards.

pub const MID_BYTES: u16 = 8_192u16

The middle value of 0x2000, indicating no bend.

pub const MAX_VALUE: u16 = 16_383u16

The maximum value of 0x3FFF, indicating full bend upwards.

pub fn from_int(int: i16) -> Self

Create a PitchBend value from an int in the range [-0x2000, 0x1FFF].

Integers outside this range will be clamped.

pub fn from_f32(float: f32) -> Self

Create a PitchBend value from a number in the range [-1.0, 1.0).

Floats outside this range will be clamped.

pub fn from_f64(float: f64) -> Self

Create a PitchBend value from a number in the range [-1.0, 1.0).

Floats outside this range will be clamped.

pub fn as_int(self) -> i16

Returns an int in the range [-0x2000, 0x1FFF].

Do not use this when writing to a midi file.

pub fn as_f32(self) -> f32

Returns an f32 in the range [-1.0, 1.0).

pub fn as_f64(self) -> f64

Returns an f64 in the range [-1.0, 1.0).

Trait Implementations

impl Clone for PitchBend

fn clone(&self) -> PitchBend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PitchBend

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

Formats the value using the given formatter.

impl Hash for PitchBend

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PitchBend

fn eq(&self, other: &PitchBend) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PitchBend

impl Eq for PitchBend

impl StructuralPartialEq for PitchBend