Enum DspType

#[repr(C)]
pub enum DspType {
    Unknown = 0,
    Mixer = 1,
    Oscillator = 2,
    LowPass = 3,
    ITLowPass = 4,
    HighPass = 5,
    Echo = 6,
    Flange = 7,
    Distortion = 8,
    Normalize = 9,
    Parameq = 10,
    PitchShift = 11,
    Chorus = 12,
    VSTPlugin = 13,
    WinampPlugin = 14,
    ITEcho = 15,
    Compressor = 16,
    SFXReverb = 17,
    LowPassSimple = 18,
    Delay = 19,
    Tremolo = 20,
    LADSPAPlugin = 21,
    HighPassSimple = 22,
    Hardware = 1_000,
    ForceInt = 65_536,
}

These definitions can be used for creating FMOD defined special effects or DSP units. Used with Dsp::set_parameter and Dsp::get_parameter.

Variants

Unknown = 0

This unit was created via a non FMOD plugin so has an unknown purpose.

Mixer = 1

This unit does nothing but take inputs and mix them together then feed the result to the soundcard unit.

Oscillator = 2

This unit generates sine/square/saw/triangle or noise tones.

LowPass = 3

This unit filters sound using a high quality, resonant lowpass filter algorithm but consumes more CPU time.

ITLowPass = 4

This unit filters sound using a resonant lowpass filter algorithm that is used in Impulse Tracker, but with limited Cutoff range (0 to 8060hz).

HighPass = 5

This unit filters sound using a resonant highpass filter algorithm.

Echo = 6

This unit produces an echo on the sound and fades out at the desired rate.

Flange = 7

This unit produces a flange effect on the sound.

Distortion = 8

This unit distorts the sound.

Normalize = 9

This unit normalizes or amplifies the sound to a certain level.

Parameq = 10

This unit attenuates or amplifies a selected frequency range.

PitchShift = 11

This unit bends the pitch of a sound without changing the speed of playback.

Chorus = 12

This unit produces a chorus effect on the sound.

VSTPlugin = 13

This unit allows the use of Steinberg VST plugins

WinampPlugin = 14

This unit allows the use of Nullsoft Winamp plugins

ITEcho = 15

This unit produces an echo on the sound and fades out at the desired rate as is used in Impulse Tracker.

Compressor = 16

This unit implements dynamic compression (linked multichannel, wideband)

SFXReverb = 17

This unit implements SFX reverb

LowPassSimple = 18

This unit filters sound using a simple lowpass with no resonance, but has flexible Cutoff and is fast.

Delay = 19

This unit produces different delays on individual channels of the sound.

Tremolo = 20

This unit produces a tremolo / chopper effect on the sound.

LADSPAPlugin = 21

This unit allows the use of LADSPA standard plugins.

HighPassSimple = 22

This unit filters sound using a simple highpass with no resonance, but has flexible Cutoff and is fast.

Hardware = 1_000

Offset that platform specific FMOD_HARDWARE DSPs will start at.

ForceInt = 65_536

Makes sure this enum is signed 32bit.

Trait Implementations

impl Clone for DspType

fn clone(&self) -> DspType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DspType

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

Formats the value using the given formatter.

impl PartialEq for DspType

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

fn partial_cmp(&self, other: &DspType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DspType

impl StructuralPartialEq for DspType