Enum SoundGroupBehavior

#[repr(C)]
pub enum SoundGroupBehavior {
    Fail = 0,
    Mute = 1,
    StealLowest = 2,
    Max = 3,
    ForceInt = 65_536,
}

These flags are used with SoundGroup::set_max_audible_behavior to determine what happens when more sounds are played than are specified with SoundGroup::set_max_audible.

Variants

Fail = 0

Any sound played that puts the sound count over the SoundGroup::set_max_audible setting, will simply fail during Sound::play.

Mute = 1

Any sound played that puts the sound count over the SoundGroup::set_max_audible setting, will be silent, then if another sound in the group stops the sound that was silent before becomes audible again.

StealLowest = 2

Any sound played that puts the sound count over the SoundGroup::set_max_audible setting, will steal the quietest / least important sound playing in the group.

Max = 3

Maximum number of open state types.

ForceInt = 65_536

Makes sure this enum is signed 32bit.

Trait Implementations

impl Clone for SoundGroupBehavior

fn clone(&self) -> SoundGroupBehavior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundGroupBehavior

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

Formats the value using the given formatter.

impl PartialEq for SoundGroupBehavior

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

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

impl StructuralPartialEq for SoundGroupBehavior