Skip to main content

SclScale

Struct SclScale 

Source
pub struct SclScale { /* private fields */ }
Expand description

A parsed Scala scale: count pitch entries describing one period above the implicit 1/1. Fixed-size and Copy — no heap, safe to embed in the tuning-table build path.

Implementations§

Source§

impl SclScale

Source

pub fn count(&self) -> usize

Number of pitch degrees (the value on the .scl count line). Degree 0 (1/1) is implicit, so the scale spans degrees 0..=count, with degree count being the formal octave/period.

Source

pub fn entry(&self, degree: usize) -> Option<SclEntry>

Entry for scale degree degree in 1..=count (degree 1 is the first listed pitch). Returns None for degree 0 (which is always 1/1) or out of range.

Source

pub fn degree_cents(&self, degree: usize) -> f64

Cumulative cents of scale degree degree relative to 1/1. Degree 0 ⇒ 0.0; degree d in 1..=count ⇒ the d-th listed pitch’s cents. Degrees above count are clamped to the period (callers handle octave wrapping).

Source

pub fn twelve_tet() -> SclScale

12-tone equal temperament: twelve equal 100-cent steps to the 2/1 octave. Parameterised like every other scale — the engine hardcodes NOTHING; this is merely a convenience constructor for the ubiquitous default.

Trait Implementations§

Source§

impl Clone for SclScale

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SclScale

Source§

impl Debug for SclScale

Source§

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

Formats the value using the given formatter. Read more

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.