Struct jumpy::prelude::kira::spatial::emitter::EmitterSettings

pub struct EmitterSettings {
    pub distances: EmitterDistances,
    pub attenuation_function: Option<Easing>,
    pub enable_spatialization: bool,
    pub persist_until_sounds_finish: bool,
}

Settings for an emitter.

Fields

distances: EmitterDistances

The distances from a listener at which the emitter is loudest and quietest.

attenuation_function: Option<Easing>

How the emitter’s volume will change with distance.

If None, the emitter will output at a constant volume.

enable_spatialization: bool

Whether the emitter’s output should be panned left or right depending on its direction from the listener.

persist_until_sounds_finish: bool

Whether the emitter should be kept alive until all sounds are finished playing on it even if the handle is dropped.

Implementations

impl EmitterSettings

pub fn new() -> EmitterSettings

Creates a new EmitterSettings with the default settings.

pub fn distances( self, distances: impl Into<EmitterDistances>, ) -> EmitterSettings

Sets the distances from a listener at which the emitter is loudest and quietest.

pub fn attenuation_function( self, attenuation_function: impl Into<Option<Easing>>, ) -> EmitterSettings

Sets how the emitter’s volume will change with distance.

If None, the emitter will output at a constant volume.

pub fn enable_spatialization( self, enable_spatialization: bool, ) -> EmitterSettings

Sets whether the emitter’s output should be panned left or right depending on its direction from the listener.

pub fn persist_until_sounds_finish( self, persist_until_sounds_finish: bool, ) -> EmitterSettings

Sets whether the emitter should be kept alive until all sounds are finished playing on it even if the handle is dropped.

Trait Implementations

impl Clone for EmitterSettings

fn clone(&self) -> EmitterSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmitterSettings

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

Formats the value using the given formatter.

impl Default for EmitterSettings

fn default() -> EmitterSettings

Returns the “default value” for a type.

impl PartialEq for EmitterSettings

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

impl StructuralPartialEq for EmitterSettings