Trait sfml::audio::SoundSource[−][src]

pub trait SoundSource {
    fn set_pitch(&mut self, pitch: f32);

    fn set_volume(&mut self, volume: f32);

    fn set_position<P: Into<Vector3f>>(&mut self, position: P);

    fn set_relative_to_listener(&mut self, relative: bool);

    fn set_min_distance(&mut self, distance: f32);

    fn set_attenuation(&mut self, attenuation: f32);

    fn pitch(&self) -> f32;

    fn volume(&self) -> f32;

    fn position(&self) -> Vector3f;

    fn is_relative_to_listener(&self) -> bool;

    fn min_distance(&self) -> f32;

    fn attenuation(&self) -> f32;
}

Base trait defining a sound’s properties.

Required methods

fn set_pitch(&mut self, pitch: f32)[src]

Set the pitch of the sound.

The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.

Parameters

pitch - New pitch to apply to the sound

fn set_volume(&mut self, volume: f32)[src]

Set the volume of the sound.

The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.

Parameters

volume - Volume of the sound

fn set_position<P: Into<Vector3f>>(&mut self, position: P)[src]

Set the 3D position of the sound in the audio scene.

Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).

Parameters

position - Position of the sound in the scene

fn set_relative_to_listener(&mut self, relative: bool)[src]

Make the sound’s position relative to the listener or absolute.

Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).

Parameters

relative - True to set the position relative, false to set it absolute

fn set_min_distance(&mut self, distance: f32)[src]

Set the minimum distance of the sound.

The “minimum distance” of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 (“inside the head of the listener”) is an invalid value and is forbidden. The default value of the minimum distance is 1.

Parameters

distance - New minimum distance of the sound

fn set_attenuation(&mut self, attenuation: f32)[src]

Set the attenuation factor of the sound.

The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

Parameters

attenuation - New attenuation factor of the sound

fn pitch(&self) -> f32[src]

Get the pitch of the sound.

fn volume(&self) -> f32[src]

Get the volume of the sound.

Returns the volume of the sound, in the range [0, 100]

fn position(&self) -> Vector3f[src]

Get the 3D position of the sound in the audio scene.

fn is_relative_to_listener(&self) -> bool[src]

Tell whether the sound’s position is relative to the listener or is absolute.

fn min_distance(&self) -> f32[src]

Get the minimum distance of the sound.

fn attenuation(&self) -> f32[src]

Get the attenuation factor of the sound.

Loading content...

Implementors

impl SoundSource for Music[src]

impl<'a, S: SoundStream> SoundSource for SoundStreamPlayer<'a, S>[src]

impl<'s> SoundSource for Sound<'s>[src]

Loading content...