Firelight Technologies FMOD Studio API

FMOD_INITFLAGS

Initialization flags. Use them with System::init in the flags parameter to change various behavior.

Use System::setAdvancedSettings to adjust settings for some of the features that are enabled by these flags.

Definition

#define FMOD_INIT_NORMAL 0x00000000
#define FMOD_INIT_STREAM_FROM_UPDATE 0x00000001
#define FMOD_INIT_MIX_FROM_UPDATE 0x00000002
#define FMOD_INIT_3D_RIGHTHANDED 0x00000004
#define FMOD_INIT_SOFTWARE_DISABLE 0x00000100
#define FMOD_INIT_CHANNEL_LOWPASS 0x00000200
#define FMOD_INIT_CHANNEL_DISTANCEFILTER 0x00000400
#define FMOD_INIT_PROFILE_ENABLE 0x00010000
#define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00020000
#define FMOD_INIT_GEOMETRY_USECLOSEST 0x00040000
#define FMOD_INIT_PREFER_DOLBY_DOWNMIX 0x00080000
#define FMOD_INIT_THREAD_UNSAFE 0x00100000

Values

FMOD_INIT_NORMAL

Initialize normally

FMOD_INIT_STREAM_FROM_UPDATE

No stream thread is created internally. Streams are driven from System::update. Mainly used with non-realtime outputs.

FMOD_INIT_MIX_FROM_UPDATE

Win32/Wii/PS3/Xbox/Xbox 360 Only - FMOD Mixer thread is woken up to do a mix when System::update is called rather than waking periodically on its own timer.

FMOD_INIT_3D_RIGHTHANDED

FMOD will treat +X as right, +Y as up and +Z as backwards (towards you).

FMOD_INIT_SOFTWARE_DISABLE

Disable software mixer to save memory. Anything created with FMOD_SOFTWARE will fail and DSP will not work.

FMOD_INIT_CHANNEL_LOWPASS

All FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which is automatically used when Channel::set3DOcclusion is used or the geometry API. This also causes sounds to sound duller when the sound goes behind the listener, as a fake HRTF style effect. Use System::setAdvancedSettings to disable or adjust cutoff frequency for this feature.

FMOD_INIT_CHANNEL_DISTANCEFILTER

All FMOD_3D based voices will add a software lowpass and highpass filter effect into the DSP chain which will act as a distance-automated bandpass filter. Use System::setAdvancedSettings to adjust the center frequency.

FMOD_INIT_PROFILE_ENABLE

Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time.

FMOD_INIT_VOL0_BECOMES_VIRTUAL

Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually. Use System::setAdvancedSettings to adjust what volume besides zero to switch to virtual at.

FMOD_INIT_GEOMETRY_USECLOSEST

With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects.

FMOD_INIT_PREFER_DOLBY_DOWNMIX

When using FMOD_SPEAKERMODE_5POINT1 with a stereo output device, use the Dolby Pro Logic II downmix algorithm instead of the SRS Circle Surround algorithm.

FMOD_INIT_THREAD_UNSAFE

Disables thread safety for API calls. Only use this if FMOD low level is being called from a single thread, and if Studio API is not being used!

See Also




Version 1.03.06 Built on Apr 17, 2014