tuxmain/HexoDSP
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed the documentation code for PolyBlepOscillator

Browse source
This commit is contained in:
Weird Constructor 2021-08-01 06:55:43 +02:00
parent b974ed0bd7
commit 94c4428d04
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/dsp/helpers.rs
View file

@ -1209,7 +1209,7 @@ fn poly_blep(t: f32, dt: f32) -> f32 {
/// Here is a quick example on how to use it: /// Here is a quick example on how to use it:
/// ///
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// // Randomize the initial phase to make cancellation on summing less /// // Randomize the initial phase to make cancellation on summing less
/// // likely: /// // likely:
@ -1222,6 +1222,7 @@ fn poly_blep(t: f32, dt: f32) -> f32 {
/// let pw = 0.2; // Pulse-Width for the next_pulse() /// let pw = 0.2; // Pulse-Width for the next_pulse()
/// let waveform = 0; // 0 being pulse in this example, 1 being sawtooth /// let waveform = 0; // 0 being pulse in this example, 1 being sawtooth
/// ///
/// let mut block_of_samples = [0.0; 128];
/// // in your process function: /// // in your process function:
/// for output_sample in block_of_samples.iter_mut() { /// for output_sample in block_of_samples.iter_mut() {
/// *output_sample = /// *output_sample =
@ -1248,7 +1249,7 @@ impl PolyBlepOscillator {
/// oscillators. /// oscillators.
/// ///
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
///``` ///```
@ -1273,7 +1274,7 @@ impl PolyBlepOscillator {
/// * `freq` - The frequency in Hz. /// * `freq` - The frequency in Hz.
/// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`. /// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`.
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
/// ///
@ -1302,7 +1303,7 @@ impl PolyBlepOscillator {
/// * `freq` - The frequency in Hz. /// * `freq` - The frequency in Hz.
/// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`. /// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`.
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
/// ///
@ -1342,7 +1343,7 @@ impl PolyBlepOscillator {
/// * `freq` - The frequency in Hz. /// * `freq` - The frequency in Hz.
/// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`. /// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`.
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
/// ///
@ -1375,7 +1376,7 @@ impl PolyBlepOscillator {
/// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`. /// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`.
/// * `pw` - The pulse width. Use the value 0.0 for a square wave. /// * `pw` - The pulse width. Use the value 0.0 for a square wave.
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
/// ///
@ -1384,7 +1385,7 @@ impl PolyBlepOscillator {
/// let pw = 0.0; // 0.0 is a square wave. /// let pw = 0.0; // 0.0 is a square wave.
/// ///
/// // ... /// // ...
/// let sample = osc.next_pulse(freq, israte); /// let sample = osc.next_pulse(freq, israte, pw);
/// // ... /// // ...
///``` ///```
#[inline] #[inline]
@ -1419,7 +1420,7 @@ impl PolyBlepOscillator {
/// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`. /// * `israte` - The inverse sampling rate, or seconds per sample as in eg. `1.0 / 44100.0`.
/// * `pw` - The pulse width. Use the value 0.0 for a square wave. /// * `pw` - The pulse width. Use the value 0.0 for a square wave.
///``` ///```
/// use HexoDSP::dsp::helpers::{PolyBlepOscillator, rand_01}; /// use hexodsp::dsp::helpers::{PolyBlepOscillator, rand_01};
/// ///
/// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25); /// let mut osc = PolyBlepOscillator::new(rand_01() * 0.25);
/// ///