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
impl SclScale
Sourcepub fn count(&self) -> usize
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.
Sourcepub fn entry(&self, degree: usize) -> Option<SclEntry>
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.
Sourcepub fn degree_cents(&self, degree: usize) -> f64
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).
Sourcepub fn twelve_tet() -> SclScale
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.