Module: FMOD::Core::InitFlags

Defined in:: lib/fmod/core/init_flags.rb

Overview

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

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

Constant Summary collapse

NORMAL = Initialize normally.

0x00000000

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

0x00000001

MIX_FROM_UPDATE = No mixer thread is created internally. Mixing is driven from System.update.

0x00000002

RIGHT_HANDED_3D = 3D calculations will be performed in right-handed coordinates.

0x00000004

CHANNEL_LOW_PASS = Enables usage of Channel low-pass gain, Channel occlusion, or automatic usage by the Geometry API. All voices will add a software low-pass filter effect into the DSP chain which is idle unless one of the previous functions/features are used.

0x00000100

CHANNEL_DISTANCE_FILTER = All FMOD 3D based voices will add a software low-pass and high-pass filter effect into the DSP chain which will act as a distance-automated bandpass filter. Use System advanced settings to adjust the center frequency.

0x00000200

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.

0x00010000

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 advanced settings to adjust what volume besides zero to switch to virtual at.

0x00020000

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

0x00040000

PREFER_DOLBY_DOWN_MIX = When using a 5.1 speaker mode with a stereo output device, use the Dolby Pro Logic II down-mix algorithm instead of the SRS Circle Surround algorithm.

0x00080000

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!

0x00100000

PROFILE_METER_ALL = Slower, but adds level metering for every single DSP unit in the graph.

0x00200000

DISABLE_SRS_HIGH_PASS_FILTER = Using a 5.1 speaker mode with a stereo output device will enable the SRS Circle Surround down-mixer. By default the SRS down-mixer applies a high pass filter with a cutoff frequency of 80Hz. Use this flag to disable the high pass filter, or use PREFER_DOLBY_DOWN_MIX to use the Dolby Pro Logic II down-mix algorithm instead.

0x00400000