Struct thorium::dmg_apu::FrequencySweep

pub struct FrequencySweep {
    pub frequency_setting: u16,
    pub rate: i8,
    pub shift: u8,
    pub samples: usize,
}

Fields

frequency_setting: u16

The frequency setting is an 11-bit value.

• 131072/(2048-x) Hz
• Should always be set in the range 0..2048

rate: i8

How often the frequency will sweep up or down.

• Given in 1/128th Sec units, correct range is +/- 7.
• + sweeps the frequency up, - sweeps the frequency down.
• Use 0 for no sweeping.

shift: u8

How much to sweep by when a sweep happens.

samples: usize

How many samples until we trigger a sweep and re-assess things.

Methods

impl FrequencySweep

pub fn setting_for(target: i32) -> u16

Gets the frequency setting that is as close as possible to the target.

pub fn samples_until_trigger(rate: i8, samples_per_second: i32) -> usize

Given a rate and SPS, how many samples until the effect triggers.

If the rate is 0, it will "never" trigger, so usize::MAX is given.

pub fn new(freq: i32, rate: i8, shift: u8, samples_per_second: i32) -> Self

Constructs a new FrequencySweep with appropriate settings

Does a debug_assert! that all values are correct.

pub fn frequency(&self) -> i32

Obtains the real frequency of the current frequency setting.

pub fn in_samples_per_out_sample(&self, samples_per_second: i32) -> f32

pub fn tick_sample(&mut self, samples_per_second: i32) -> SweepTickResult

Ticks down a sample, returns if the effect actually changed the frequency.

Trait Implementations

impl Clone for FrequencySweep

fn clone(&self) -> FrequencySweep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FrequencySweep

impl Default for FrequencySweep

fn default() -> Self

Returns the "default value" for a type.

impl Debug for FrequencySweep

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

Formats the value using the given formatter.