Skip to content

Commit a3b7ffc

Browse files
committed
cleanup parametertypes
1 parent 9702666 commit a3b7ffc

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

src/dsp/interop.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ pub fn into_desc<D: Dsp>() -> FMOD_DSP_DESCRIPTION {
196196
datatype: FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN as i32
197197
}
198198
} },
199-
ParameterType::_3DAttrs
199+
ParameterType::ListenerAttributes
200200
=> { FMOD_DSP_PARAMETER_DESC__bindgen_ty_1 { datadesc: FMOD_DSP_PARAMETER_DESC_DATA {
201201
datatype: FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES as i32
202202
}
@@ -211,7 +211,7 @@ pub fn into_desc<D: Dsp>() -> FMOD_DSP_DESCRIPTION {
211211
datatype: FMOD_DSP_PARAMETER_DATA_TYPE_FFT as i32
212212
}
213213
} },
214-
ParameterType::_Multi3DAttrs
214+
ParameterType::ListenerAttributesList
215215
=> { FMOD_DSP_PARAMETER_DESC__bindgen_ty_1 { datadesc: FMOD_DSP_PARAMETER_DESC_DATA {
216216
datatype: FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES_MULTI as i32
217217
}

src/dsp/mod.rs

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,25 @@ pub enum ParameterType<Dsp: ?Sized> {
5151
setter: fn(&[u8], &mut Dsp),
5252
getter: fn(&Dsp) -> (&[u8], &str),
5353
},
54-
// supplied by FMOD Studio
55-
// TODO: accompanying data structures
56-
OverallGain,
57-
_3DAttrs,
54+
// max of 1 of these
55+
/// Provides access to an additional signal input. The parameter itself is set to `true` when
56+
/// a sidechain input exists; use `interop::with_sidechain` to access the signal itself.
5857
Sidechain {
5958
setter: fn(bool, &mut Dsp),
6059
getter: fn(&Dsp) -> bool,
6160
},
62-
Fft,
63-
_Multi3DAttrs,
64-
AttenuationRange,
61+
// TODO: accompanying data structures
6562
DynamicResponse,
63+
/// Read by FMOD Studio to decide when to virtualize sounds.
64+
OverallGain,
65+
/// Set by FMOD Studio with the player's position and attributes.
66+
ListenerAttributes,
67+
/// Set by FMOD Studio with all player's positions and attributes, if there are multiple.
68+
ListenerAttributesList,
69+
/// Set by FMOD Studio to the min/max range of the event containing this DSP.
70+
AttenuationRange,
71+
/// Set to provide access to FFT data to games.
72+
Fft,
6673
}
6774

6875
pub trait Dsp {

0 commit comments

Comments
 (0)