Struct midly::PitchBend

pub struct PitchBend(pub u14);

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.

Tuple Fields

0: u14

Implementations

impl PitchBend

pub const fn min_raw_value() -> PitchBend

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

pub const fn mid_raw_value() -> PitchBend

The middle value of 0x2000, indicating no bend.

pub const fn max_raw_value() -> PitchBend

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

pub fn from_int(int: i16) -> PitchBend

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) -> PitchBend

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) -> PitchBend

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].

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<PitchBend> for PitchBend

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 StructuralEq for PitchBend

impl StructuralPartialEq for PitchBend