-
Notifications
You must be signed in to change notification settings - Fork 3
reverb_3d
FMOD Object: Reverb3D
This module holds functionality related to virtual 3D reverb spheres. See the FMOD 3D Reverb guide for more information.
This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.
- fmod_reverb_3d_set_3d_attributes
- fmod_reverb_3d_get_3d_attributes
- fmod_reverb_3d_set_properties
- fmod_reverb_3d_get_properties
- fmod_reverb_3d_set_active
- fmod_reverb_3d_get_active
- fmod_reverb_3d_release
- fmod_reverb_3d_set_user_data
- fmod_reverb_3d_get_user_data
FMOD Function: Reverb3D::set3DAttributes
This function sets the 3D attributes of a reverb sphere.
When the position of the listener is less than max_distance away from the position of one or more reverb objects, the listener's 3D reverb properties are a weighted combination of those reverb objects. Otherwise, the reverb DSP will use the global reverb settings.
See the 3D Reverb guide for more information.
Syntax:
fmod_reverb_3d_set_3d_attributes(reverb_3d_ref, position, min_distance, max_distance)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
| position | FmodVector | The position in 3D space representing the center of the reverb. Expressed in Distance units. |
| min_distance | Real | The distance from the centerpoint within which the reverb will have full effect. Expressed in Distance units. |
| max_distance | Real | The distance from the centerpoint beyond which the reverb will have no effect. Expressed in Distance units. |
Returns:
N/A
FMOD Function: Reverb3D::get3DAttributes
This function retrieves the 3D attributes of a reverb sphere.
See the 3D Reverb guide for more information.
Syntax:
fmod_reverb_3d_get_3d_attributes(reverb_3d_ref)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
Returns:
FMOD Function: Reverb3D::setProperties
This function sets the environmental properties of a reverb sphere.
Note
the default reverb properties are the same as the FMOD_PRESET_GENERIC preset under FMOD_REVERB_PRESETS.
Syntax:
fmod_reverb_3d_set_properties(reverb_3d_ref, decay_time, early_delay, late_delay, hf_reference, hf_decay_ratio, diffusion, density, low_shelf_frequency, low_shelf_gain, high_cut, early_late_mix, wet_level)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
| decay_time | Real | The reverberation decay time, expressed in milliseconds. A value in the range [0, 20000]. |
| early_delay | Real | The initial reflection delay time, expressed in milliseconds. A value in the range [0, 300]. |
| late_delay | Real | The late reverberation delay time relative to initial reflection, expressed in milliseconds. A value in the range [0, 100]. |
| hf_reference | Real | The reference high frequency, in Hertz. A value in the range [20, 20000]. |
| hf_decay_ratio | Real | The high-frequency to mid-frequency decay time ratio, as a percentage. A value in the range [10, 100]. |
| diffusion | Real | A value that controls the echo density in the late reverberation decay, as a percentage. A value in the range [10, 100]. |
| density | Real | A value that controls the modal density in the late reverberation decay, as a percentage. A value in the range [0, 100]. |
| low_shelf_frequency | Real | The reference low frequency, in Hertz. A value in the range [20, 1000]. |
| low_shelf_gain | Real | The relative room effect level at low frequencies, expressed in decibels (dB). A value in the range [-36, 12]. |
| high_cut | Real | The relative room effect level at high frequencies, in Hertz. A value in the range [0, 20000]. |
| early_late_mix | Real | The early reflections level relative to room effect, as a percentage. |
| wet_level | Real | The room effect level at mid frequencies, expressed in decibels (dB). A value in the range [-80, 20]. |
Returns:
N/A
FMOD Function: Reverb3D::getProperties
This function retrieves the environmental properties of a reverb sphere.
See the 3D Reverb guide for more information.
Syntax:
fmod_reverb_3d_get_properties(reverb_3d_ref)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
Returns:
FMOD Function: Reverb3D::setActive
This function sets the active state.
See the 3D Reverb guide for more information.
Syntax:
fmod_reverb_3d_set_active(reverb_3d_ref, active)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
| active | Boolean | The active state of the reverb sphere. The default is true. |
Returns:
N/A
FMOD Function: Reverb3D::getActive
This function retrieves the active state of a reverb sphere.
See the 3D Reverb guide for more information.
Syntax:
fmod_reverb_3d_get_active(reverb_3d_ref)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
Returns:
FMOD Function: Reverb3D::release
This function releases the memory for a reverb object and makes it inactive.
Note
If you release all Reverb3D objects and have not added a new Reverb3D object, fmod_system_set_reverb_properties should be called to reset the reverb properties.
Syntax:
fmod_reverb_3d_release(reverb_3d_ref)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
Returns:
N/A
FMOD Function: Reverb3D::setUserData
This function sets a single floating-point user value associated with this object.
Note
While FMOD supports arbitrary User Data, this function only allows you to set a real value (a double-precision floating-point value).
Syntax:
fmod_reverb_3d_set_user_data(reverb_3d_ref, data)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
| data | Real | The value stored on this object. |
Returns:
N/A
FMOD Function: Reverb3D::getUserData
This function retrieves a floating-point user value associated with this object, as set with an earlier call to fmod_reverb_3d_set_user_data.
Note
While FMOD allows arbitrary User Data, this function only allows you to get a real value (a double-precision floating-point value).
Syntax:
fmod_reverb_3d_get_user_data(reverb_3d_ref)
| Argument | Type | Description |
|---|---|---|
| reverb_3d_ref | Real | A reference to a Reverb3D. |
Returns:
YoYoGames 2024