Struct AudioSource 

#[non_exhaustive]
pub struct AudioSource {
    pub sound_name: String,
    pub is_3d: bool,
    pub volume: f32,
    pub pitch: f32,
    pub loop_sound: bool,
    pub max_distance: f32,
    pub _internal_sink_id: Option<u64>,
    pub has_played: bool,
}

ECS component for a sound source that can be played in 2D or 3D.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sound_name: String

Name of the loaded sound to play (see AudioManager::load_sound).

is_3d: bool

Whether the sound should be played as a 3D spatial source.

volume: f32

Playback volume multiplier (1.0 = original volume).

pitch: f32

Playback pitch/speed multiplier (1.0 = original pitch).

loop_sound: bool

Whether the sound should loop indefinitely.

max_distance: f32

Distance at which the sound is fully attenuated (silent).

_internal_sink_id: Option<u64>

Internal id of the active sink playing this source, if any.

has_played: bool

Latches once this source has been auto-started, so a finished one-shot is not restarted every frame. (When a one-shot ends the spatial system clears _internal_sink_id; without this sentinel the auto-start guard would fire again next frame → infinite repeat.) Transient runtime state — not persisted.

Implementations

impl AudioSource

pub fn new(name: &str) -> AudioSource

Creates a new AudioSource for the sound with the given name.

pub fn with_loop(self, l: bool) -> AudioSource

Sets whether the sound loops, returning the modified source.

pub fn with_max_distance(self, dist: f32) -> AudioSource

Sets the attenuation distance, returning the modified source.

Trait Implementations

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for AudioSource

fn storage_type() -> StorageType

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl Default for AudioSource

fn default() -> AudioSource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioSource

fn deserialize<__D>( __deserializer: __D, ) -> Result<AudioSource, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AudioSource

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AudioSource

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AudioSource