Struct amethyst_audio::AudioSystem

pub struct AudioSystem(_);

Syncs 3D transform data with the audio engine to provide 3D audio.

Methods

impl AudioSystem

pub fn new(f0: Output) -> Self

Constructs a new AudioSystem.

Trait Implementations

impl Default for AudioSystem

fn default() -> AudioSystem

Returns the "default value" for a type.

impl Debug for AudioSystem

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

Formats the value using the given formatter.

impl<'a, 'b> SystemDesc<'a, 'b, AudioSystem> for AudioSystemDesc

fn build(self, world: &mut World) -> AudioSystem

Builds and returns a System.

impl<'a> System<'a> for AudioSystem

type SystemData = (Option<Read<'a, Output>>, Option<Read<'a, SelectedListener>>, Entities<'a>, ReadStorage<'a, Transform>, ReadStorage<'a, AudioListener>, WriteStorage<'a, AudioEmitter>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (output, select_listener, entities, transform, listener, audio_emitter): Self::SystemData
)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.