DspType

Enum DspType 

Source
#[repr(u32)]
pub enum DspType {
Show 34 variants Unknown = 0, Mixer = 1, Oscillator = 2, Lowpass = 3, ItLowpass = 4, Highpass = 5, Echo = 6, Fader = 7, Flange = 8, Distortion = 9, Normalize = 10, Limiter = 11, ParamEq = 12, PitchShift = 13, Chorus = 14, ItEcho = 15, Compressor = 16, SfxReverb = 17, LowpassSimple = 18, Delay = 19, Tremolo = 20, Send = 21, Return = 22, HighpassSimple = 23, Pan = 24, ThreeEq = 25, Fft = 26, LoudnessMeter = 27, ConvolutionReverb = 28, ChannelMix = 29, Transceiver = 30, ObjectPan = 31, MultibandEq = 32, MultibandDynamics = 33,
}
Expand description

DSP types.

Variants§

§

Unknown = 0

Was created via a non-FMOD plug-in and has an unknown purpose.

§

Mixer = 1

Does not process the signal. Acts as a unit purely for mixing inputs.

§

Oscillator = 2

Generates sine/square/saw/triangle or noise tones.

See FMOD_DSP_OSCILLATOR for parameter information.

§

Lowpass = 3

👎Deprecated

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

Deprecated and will be removed in a future release. See FMOD_DSP_LOWPASS remarks for parameter information.

§

ItLowpass = 4

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

See FMOD_DSP_ITLOWPASS for parameter information.

§

Highpass = 5

👎Deprecated

Filters sound using a resonant highpass filter algorithm.

Deprecated and will be removed in a future release. See FMOD_DSP_HIGHPASS remarks for parameter information.

§

Echo = 6

Produces an echo on the sound and fades out at the desired rate.

See FMOD_DSP_ECHO for parameter information.

§

Fader = 7

Pans and scales the volume of a unit.

See FMOD_DSP_FADER for parameter information.

§

Flange = 8

Produces a flange effect on the sound.

See FMOD_DSP_FLANGE for parameter information.

§

Distortion = 9

Distorts the sound.

See FMOD_DSP_DISTORTION for parameter information.

§

Normalize = 10

Normalizes or amplifies the sound to a certain level.

See FMOD_DSP_NORMALIZE for parameter information.

§

Limiter = 11

Limits the sound to a certain level.

See FMOD_DSP_LIMITER for parameter information.

§

ParamEq = 12

👎Deprecated

Attenuates or amplifies a selected frequency range.

Deprecated and will be removed in a future release. See FMOD_DSP_PARAMEQ for parameter information.

§

PitchShift = 13

Bends the pitch of a sound without changing the speed of playback.

See FMOD_DSP_PITCHSHIFT for parameter information.

§

Chorus = 14

Produces a chorus effect on the sound.

See FMOD_DSP_CHORUS for parameter information.

§

ItEcho = 15

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

See FMOD_DSP_ITECHO for parameter information.

§

Compressor = 16

Dynamic compression (linked/unlinked multi-channel, wideband).

See FMOD_DSP_COMPRESSOR for parameter information.

§

SfxReverb = 17

I3DL2 reverb effect.

See FMOD_DSP_SFXREVERB for parameter information.

§

LowpassSimple = 18

👎Deprecated

Filters sound using a simple lowpass with no resonance.

Deprecated and will be removed in a future release. See FMOD_DSP_LOWPASS_SIMPLE remarks for parameter information.

§

Delay = 19

Produces different delays on individual channels of the sound.

See FMOD_DSP_DELAY for parameter information.

§

Tremolo = 20

Produces a tremolo / chopper effect on the sound.

See FMOD_DSP_TREMOLO for parameter information.

§

Send = 21

Sends a copy of the signal to a return DSP anywhere in the DSP tree.

See FMOD_DSP_SEND for parameter information.

§

Return = 22

Receives signals from a number of send DSPs.

See FMOD_DSP_RETURN for parameter information.

§

HighpassSimple = 23

👎Deprecated

Filters sound using a simple highpass with no resonance, but has flexible cutoff and is fast.

Deprecated and will be removed in a future release. See FMOD_DSP_HIGHPASS_SIMPLE remarks for parameter information.

§

Pan = 24

Pans the signal in 2D or 3D, possibly upmixing or downmixing as well.

See FMOD_DSP_PAN for parameter information.

§

ThreeEq = 25

Three-band equalizer.

See FMOD_DSP_THREE_EQ for parameter information.

§

Fft = 26

Analyzes the signal and provides spectrum information back through Dsp::get_parameter.

See FMOD_DSP_FFT for parameter information.

§

LoudnessMeter = 27

Analyzes the loudness and true peak of the signal.

§

ConvolutionReverb = 28

Convolution reverb.

See FMOD_DSP_CONVOLUTION_REVERB for parameter information.

§

ChannelMix = 29

Provides per channel gain, channel grouping of the input signal which also sets the speaker format for the output signal, and customizable input to output channel routing.

See FMOD_DSP_CHANNELMIX for parameter information.

§

Transceiver = 30

‘sends’ and ‘receives’ from a selection of up to 32 different slots. It is like a send/return but it uses global slots rather than returns as the destination. It also has other features. Multiple transceivers can receive from a single channel, or multiple transceivers can send to a single channel, or a combination of both.

See FMOD_DSP_TRANSCEIVER for parameter information.

§

ObjectPan = 31

Spatializes input signal by passing it to an external object mixer.

See FMOD_DSP_OBJECTPAN for parameter information.

§

MultibandEq = 32

Five band parametric equalizer.

See FMOD_DSP_MULTIBAND_EQ for parameter information.

§

MultibandDynamics = 33

Available on fmod_eq_2_3 only.

Three-band compressor/expander.

See FMOD_DSP_MULTIBAND_DYNAMICS for parameter information.

Trait Implementations§

Source§

impl Clone for DspType

Source§

fn clone(&self) -> DspType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DspType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<DspType> for u32

Source§

fn from(enum_value: DspType) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DspType

Source§

fn eq(&self, other: &DspType) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl TryFrom<u32> for DspType

Source§

type Error = TryFromPrimitiveError<DspType>

The type returned in the event of a conversion error.
Source§

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.
Source§

impl TryFromPrimitive for DspType

Source§

impl UnsafeFromPrimitive for DspType

Source§

type Primitive = u32

Source§

unsafe fn unchecked_transmute_from(number: Self::Primitive) -> Self

Transmutes into an enum from its primitive. Read more
Source§

unsafe fn from_unchecked(number: Self::Primitive) -> Self

👎Deprecated since 0.6.0: Prefer to use unchecked_transmute_from, from_unchecked will be removed in a future release.
Transmutes into an enum from its primitive. Read more
Source§

impl Copy for DspType

Source§

impl Eq for DspType

Source§

impl StructuralPartialEq for DspType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.