Struct let_engine::resources::sounds::AudioSettings

pub struct AudioSettings {
    pub sound_capacity: usize,
    pub object_bound_sound_capacity: usize,
    pub spatial_scene_capacity: usize,
}

The global audio settings that should be used throughout the game.

Fields

sound_capacity: usize

The limit of how many sounds can exist at the same time.

object_bound_sound_capacity: usize

The limit of how many sounds can be bound to objects to make them spatial.

spatial_scene_capacity: usize

The limit of how many scenes can play spatial sounds.

Implementations

impl AudioSettings

pub fn new() -> Self

Makes default audio settings.

pub fn set_sound_capacities(&mut self, sound_capacity: usize)

Sets the maximum amount of sounds.

pub fn sound_capacity(self, sound_capacity: usize) -> Self

Sets the maximum amount of sounds and returns self.

pub fn set_object_bound_sound_capacity(&mut self, sound_capacity: usize)

Sets the maximum amount of sounds you can bind on objects to make them spatial.

pub fn object_bound_sound_capacity(self, sound_capacity: usize) -> Self

Sets the maximum amount of sounds you can bind on objects to make them spatial and returns self.

pub fn set_spatial_scene_capacity(&mut self, scene_capacity: usize)

Sets the maximum amount of scenes that can play spatial sounds.

pub fn spatial_scene_capacity(self, scene_capacity: usize) -> Self

Sets the maximum amount of scenes that can play spatial sounds and returns self.

Trait Implementations

impl Clone for AudioSettings

fn clone(&self) -> AudioSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioSettings

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

Formats the value using the given formatter.

impl Default for AudioSettings

fn default() -> Self

Returns the “default value” for a type.

impl Ord for AudioSettings

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

Restrict a value to a certain interval.

impl PartialEq for AudioSettings

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for AudioSettings

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for AudioSettings

impl Eq for AudioSettings

impl StructuralPartialEq for AudioSettings