Struct Mode

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

[Sound] description bitfields.

Implementations

impl Mode

pub const DEFAULT: Self

Default for all modes listed below.

pub const LOOP_OFF: Self

For non looping [Sound]s. (Default)

Overrides [LOOP_NORMAL] / [LOOP_BIDI].

pub const LOOP_NORMAL: Self

For forward looping [Sound]s.

pub const LOOP_BIDI: Self

For bidirectional looping [Sound]s. (only works on non-streaming, real voices).

pub const D2: Self

Ignores any 3d processing. (Default)

pub const D3: Self

Makes the [Sound] positionable in 3D. Overrides [D2].

pub const CREATE_STREAM: Self

Decompress at runtime, streaming from the source provided (ie from disk). Overrides FMOD_CREATESAMPLE and FMOD_CREATECOMPRESSEDSAMPLE. Note a stream can only be played once at a time due to a stream only having 1 stream buffer and file handle. Open multiple streams to have them play concurrently.

pub const CREATE_SAMPLE: Self

Decompress at loadtime, decompressing or decoding whole file into memory as the target sample format (ie PCM). Fastest for playback and most flexible.

pub const CREATE_COMPRESSED_SAMPLE: Self

Load MP2/MP3/FADPCM/IMAADPCM/Vorbis/AT9 or XMA into memory and leave it compressed. Vorbis/AT9/FADPCM encoding only supported in the .FSB container format. During playback the FMOD software mixer will decode it in realtime as a ‘compressed sample’. Overrides FMOD_CREATESAMPLE. If the sound data is not one of the supported formats, it will behave as if it was created with FMOD_CREATESAMPLE and decode the sound into PCM.

pub const OPEN_USER: Self

Opens a user-created static sample or stream.

pub const OPEN_MEMORY: Self

Opens a sound with a pointer to memory. Duplicates the pointer into its own buffer.

pub const OPEN_MEMORY_POINT: Self

Opens a sound with a pointer to memory.

pub const OPEN_RAW: Self

Will ignore file format and treat as raw pcm.

pub const OPEN_ONLY: Self

Just open the file, don’t prebuffer or read. Good for fast opens for info, or when [Sound::readData] is to be used.

pub const ACCURATE_TIME: Self

For [System::create_sound] - for accurate [Sound::get_length] / [Channel::set_position] on VBR MP3, and MOD/S3M/XM/IT/MIDI files. Scans file first, so takes longer to open. FMOD_OPENONLY does not affect this.

pub const MPEG_SEARCH: Self

For corrupted / bad MP3 files. This will search all the way through the file until it hits a valid MPEG header. Normally only searches for 4k.

pub const NONBLOCKING: Self

For opening [Sound]s and getting streamed subsounds (seeking) asynchronously. Use [Sound::get_open_state] to poll the state of the [Sound] as it opens or retrieves the subsound in the background.

pub const UNIQUE: Self

Unique [Sound], can only be played one at a time.

pub const HEADRELATIVE_3D: Self

Make the [Sound]’s position, velocity and orientation relative to the listener.

pub const WORLDRELATIVE_3D: Self

Make the [Sound]’s position, velocity and orientation absolute (relative to the world). (Default)

pub const INVERSE_ROLLOFF_3D: Self

This sound follows an inverse roll-off model. Below mindistance, the volume is unattenuated; as distance increases above mindistance, the volume attenuates using mindistance/distance as the gradient until it reaches maxdistance, where it stops attenuating. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. This roll-off mode accurately models the way sounds attenuate over distance in the real world. (Default)

pub const LINEAR_ROLLOFF_3D: Self

This sound follows a linear roll-off model. Below mindistance, the volume is unattenuated; as distance increases from mindistance to maxdistance, the volume attenuates to silence using a linear gradient. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. While this roll-off mode is not as realistic as inverse roll-off mode, it is easier to comprehend.

pub const LINEAR_SQUARE_ROLLOFF_3D: Self

This sound follows a linear-square roll-off model. Below mindistance, the volume is unattenuated; as distance increases from mindistance to maxdistance, the volume attenuates to silence according to a linear squared gradient. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. This roll-off mode provides steeper volume ramping close to the mindistance, and more gradual ramping close to the maxdistance, than linear roll-off mode.

pub const INVERSE_TAPERED_ROLLOFF_3D: Self

This sound follows a combination of the inverse and linear-square roll-off models. At short distances where inverse roll-off would provide greater attenuation, it functions as inverse roll-off mode; then at greater distances where linear-square roll-off mode would provide greater attenuation, it uses that roll-off mode instead. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. Inverse tapered roll-off mode approximates realistic behavior while still guaranteeing the sound attenuates to silence at maxdistance.

pub const CUSTOM_ROLLOFF_3D: Self

This sound follow a roll-off model defined by [Sound::set3DCustomRolloff] / [ChannelControl::set3DCustomRolloff]. This roll-off mode provides greater freedom and flexibility than any other, but must be defined manually.

pub const IGNORE_GEOMETRY_3D: Self

Is not affected by geometry occlusion. If not specified in [Sound::setMode], or [ChannelControl::setMode], the flag is cleared and it is affected by geometry again.

pub const IGNORE_TAGS: Self

Skips id3v2/asf/etc tag checks when opening a Sound, to reduce seek/read overhead when opening files.

pub const LOWMEM: Self

Removes some features from samples to give a lower memory overhead, like [Sound::getName].

pub const VIRTUAL_PLAYFROM_START: Self

For Channels that start virtual (due to being quiet or low importance), instead of swapping back to audible, and playing at the correct offset according to time, this flag makes the Channel play from the start.

impl Mode

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_MODE

Get the underlying bits value.

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

pub const fn from_bits(bits: FMOD_MODE) -> 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_MODE) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: FMOD_MODE) -> 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 Mode

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

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<Mode>

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 Mode

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

Formats the value using the given formatter.

impl BitAnd for Mode

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

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

type Output = Mode

The resulting type after applying the & operator.

impl BitAndAssign for Mode

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for Mode

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

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

type Output = Mode

The resulting type after applying the | operator.

impl BitOrAssign for Mode

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for Mode

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

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

type Output = Mode

The resulting type after applying the ^ operator.

impl BitXorAssign for Mode

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Extend<Mode> for Mode

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 Mode

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

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> FMOD_MODE

Get the underlying bits value.

fn from_bits_retain(bits: FMOD_MODE) -> Mode

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<Mode> for FMOD_MODE

fn from(value: Mode) -> Self

Converts to this type from the input type.

impl From<u32> for Mode

fn from(value: FMOD_MODE) -> Self

Converts to this type from the input type.

impl FromIterator<Mode> for Mode

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

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

impl IntoIterator for Mode

type Item = Mode

The type of the elements being iterated over.

type IntoIter = Iter<Mode>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Mode

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

Formats the value using the given formatter.

impl Not for Mode

fn not(self) -> Self

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

type Output = Mode

The resulting type after applying the ! operator.

impl Octal for Mode

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

Formats the value using the given formatter.

impl Ord for Mode

fn cmp(&self, other: &Mode) -> 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 Mode

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

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

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 Mode

fn partial_cmp(&self, other: &Mode) -> 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 Mode

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 Mode

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 = Mode

The resulting type after applying the - operator.

impl SubAssign for Mode

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 Mode

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

Formats the value using the given formatter.

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode