Struct bevy::audio::Pitch

pub struct Pitch {
    pub frequency: f32,
    pub duration: Duration,
}

A source of sine wave sound

Fields

frequency: f32

Frequency at which sound will be played

duration: Duration

Duration for which sound will be played

Implementations

impl Pitch

pub fn new(frequency: f32, duration: Duration) -> Pitch

Creates a new note

Examples found in repository

examples/audio/pitch.rs (line 34)

fn play_pitch(
    mut pitch_assets: ResMut<Assets<Pitch>>,
    frequency: Res<PitchFrequency>,
    mut events: EventReader<PlayPitch>,
    mut commands: Commands,
) {
    for _ in events.read() {
        info!("playing pitch with frequency: {}", frequency.0);
        commands.spawn(PitchBundle {
            source: pitch_assets.add(Pitch::new(frequency.0, Duration::new(1, 0))),
            settings: PlaybackSettings::DESPAWN,
        });
        info!("number of pitch assets: {}", pitch_assets.len());
    }
}

Trait Implementations

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Decodable for Pitch

type DecoderItem = <SineWave as Iterator>::Item

The type of the audio samples. Usually a u16, i16 or f32, as those implement rodio::Sample. Other types can implement the rodio::Sample trait as well.

type Decoder = TakeDuration<SineWave>

The type of the iterator of the audio samples, which iterates over samples of type Self::DecoderItem. Must be a rodio::Source so that it can provide information on the audio it is iterating over.

fn decoder(&self) -> <Pitch as Decodable>::Decoder

Build and return a Self::Decoder of the implementing type

impl TypePath for Pitch

where Pitch: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl VisitAssetDependencies for Pitch

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for Pitch