Struct Pitch 

pub struct Pitch(/* private fields */);

Q5.12 pitch / sample-rate multiplier. 0x1000 = play at the sample’s recorded rate. Halving = one octave down, doubling = one octave up.

Implementations

impl Pitch

pub const UNITY: Self

0x1000 – play at the sample’s native 44100 Hz rate.

pub const OCTAVE_DOWN: Self

0x0800 – one octave below recorded rate.

pub const OCTAVE_UP: Self

0x2000 – one octave above recorded rate.

pub const MAX: Self

Hardware cap (14-bit field). Higher values clamp.

pub const fn raw(v: u16) -> Self

Raw constructor. Values above 0x3FFF clamp on hardware.

pub const fn raw_value(self) -> u16

The raw register value, as Pitch::raw took it. Callers scaling a duration by pitch need the number back: at half unity a sample lasts twice as long, and a cutoff that ignores that clips the sound.

pub const fn for_frequency(target_hz: u32, base_hz: u32) -> Self

Pitch that makes a native-rate sine loop play at hz_num / hz_den where the loop’s natural frequency is base_hz. Integer-only so no_std users can compute at compile time.

pub const fn for_sample_rate(sample_rate_hz: u32) -> Self

Pitch that plays a decoded sample stream at its declared source rate. 44100 maps to Pitch::UNITY.

pub const fn as_u16(self) -> u16

Underlying 14-bit value.

Trait Implementations

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pitch

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

Formats the value using the given formatter.

impl PartialEq for Pitch

fn eq(&self, other: &Pitch) -> 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 Pitch

impl Eq for Pitch

impl StructuralPartialEq for Pitch