Struct Sound 

pub struct Sound {
    pub name: String,
    pub is_music: bool,
    pub volume: f32,
    pub pitch: f32,
    pub looping: bool,
    pub spatial_min_distance: f32,
    pub spatial_max_distance: f32,
    pub position: Option<Vec2>,
}

A loaded sound effect.

Fields

name: String

Name identifier.

is_music: bool

Whether this is a music track (streamed) vs SFX (loaded into memory).

volume: f32

Base volume (0.0–1.0).

pitch: f32

Pitch multiplier.

looping: bool

Whether to loop.

spatial_min_distance: f32

Minimum distance for spatial audio (within this, no attenuation).

spatial_max_distance: f32

Maximum distance for spatial audio (beyond this, inaudible).

position: Option<Vec2>

2D position for spatial audio.

Implementations

impl Sound

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

Create a new sound configuration.

pub fn as_music(self) -> Self

Builder: set as music (streamed).

pub fn with_volume(self, volume: f32) -> Self

Builder: set volume.

pub fn with_pitch(self, pitch: f32) -> Self

Builder: set pitch.

pub fn with_looping(self, looping: bool) -> Self

Builder: set looping.

pub fn with_position(self, pos: Vec2) -> Self

Builder: set 2D position for spatial audio.

pub fn with_spatial_range(self, min: f32, max: f32) -> Self

Builder: set spatial distance range.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.