Struct InitFlags

pub struct InitFlags(/* private fields */);

Configuration flags used when initializing the System object.

Implementations

impl InitFlags

pub const NORMAL: Self

Initialize normally

pub const STREAM_FROM_UPDATE: Self

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

pub const MIX_FROM_UPDATE: Self

No mixer thread is created internally. Mixing is driven from [System::update]. Only applies to polling based output modes such as FMOD_OUTPUTTYPE_NOSOUND, FMOD_OUTPUTTYPE_WAVWRITER.

pub const RIGHTHANDED_3D: Self

3D calculations will be performed in right-handed coordinates, instead of the default of left-handed coordinates. See the Handedness section of the Glossary for more information.

pub const CLIP_OUTPUT: Self

Enables hard clipping of output values greater than 1.0f or less than -1.0f.

pub const CHANNEL_LOWPASS: Self

Enables usage of [ChannelControl::setLowPassGain], [ChannelControl::set3DOcclusion], or automatic usage by the Geometry API.

All voices will add a software lowpass filter effect into the DSP chain which is idle unless one of the previous functions/features are used.

pub const CHANNEL_DISTANCE_FILTER: Self

All FMOD_3D based voices add a software low pass and highpass filter effect into the DSP chain, which acts as a distance-automated bandpass filter.

Use [System::setAdvancedSettings] to adjust the center frequency.

pub const PROFILE_ENABLE: Self

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

pub const VOL_0_BECOMES_VIRTUAL: Self

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.

pub const GEOMETRY_USE_CLOSEST: Self

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

pub const PREFER_DOLBY_DOWNMIX: Self

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

pub const THREAD_UNSAFE: Self

This flag cannot be used normally as this crate has guardrails preventing it. It is still here for completeness’ sake, though.

pub const PROFILE_METER_ALL: Self

Slower, but adds level metering for every single DSP unit in the graph. Use [DSP::setMeteringEnabled] to turn meters off individually.

Setting this flag implies [PROFILE_ENABLE].

pub const MEMORY_TRACKING: Self

Enables memory allocation tracking. Currently this is only useful when using the Studio API. Increases memory footprint and reduces performance.

This flag is implied by FMOD_STUDIO_INIT_MEMORY_TRACKING.

impl InitFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> FMOD_INITFLAGS

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: FMOD_INITFLAGS) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: FMOD_INITFLAGS) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: FMOD_INITFLAGS) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl InitFlags

pub const fn iter(&self) -> Iter<InitFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<InitFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for InitFlags

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

Formats the value using the given formatter.

impl BitAnd for InitFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = InitFlags

The resulting type after applying the & operator.

impl BitAndAssign for InitFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for InitFlags

fn bitor(self, other: InitFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = InitFlags

The resulting type after applying the | operator.

impl BitOrAssign for InitFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for InitFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = InitFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for InitFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for InitFlags

fn clone(&self) -> InitFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitFlags

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

Formats the value using the given formatter.

impl Extend<InitFlags> for InitFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for InitFlags

const FLAGS: &'static [Flag<InitFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> FMOD_INITFLAGS

Get the underlying bits value.

fn from_bits_retain(bits: FMOD_INITFLAGS) -> InitFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<InitFlags> for FMOD_INITFLAGS

fn from(value: InitFlags) -> Self

Converts to this type from the input type.

impl From<u32> for InitFlags

fn from(value: FMOD_INITFLAGS) -> Self

Converts to this type from the input type.

impl FromIterator<InitFlags> for InitFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for InitFlags

type Item = InitFlags

The type of the elements being iterated over.

type IntoIter = Iter<InitFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for InitFlags

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

Formats the value using the given formatter.

impl Not for InitFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = InitFlags

The resulting type after applying the ! operator.

impl Octal for InitFlags

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

Formats the value using the given formatter.

impl Ord for InitFlags

fn cmp(&self, other: &InitFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InitFlags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for InitFlags

fn partial_cmp(&self, other: &InitFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for InitFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for InitFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = InitFlags

The resulting type after applying the - operator.

impl SubAssign for InitFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for InitFlags

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

Formats the value using the given formatter.

impl Copy for InitFlags

impl Eq for InitFlags

impl StructuralPartialEq for InitFlags