kira 0.12.0

Expressive audio library for games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use std::time::Duration;

use crate::{
	clock::ClockTime,
	info::{Info, WhenToStart},
};

/// Describes when an action should occur.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub enum StartTime {
	/// The action should occur immediately.
	#[default]
	Immediate,
	/// The action should occur a certain amount of time from now.
	Delayed(Duration),
	/// The action should occur when a clock reaches a
	/// specific time.
	ClockTime(ClockTime),
}

impl StartTime {
	pub(crate) fn update(&mut self, dt: f64, info: &Info) -> WillNeverStart {
		match self {
			StartTime::Immediate => {}
			StartTime::Delayed(time_remaining) => {
				*time_remaining = time_remaining.saturating_sub(Duration::from_secs_f64(dt));
				if time_remaining.is_zero() {
					*self = StartTime::Immediate;
				}
			}
			StartTime::ClockTime(clock_time) => match info.when_to_start(*clock_time) {
				WhenToStart::Now => {
					*self = StartTime::Immediate;
				}
				WhenToStart::Later => {}
				WhenToStart::Never => return true,
			},
		}
		false
	}
}

pub(crate) type WillNeverStart = bool;

impl From<Duration> for StartTime {
	fn from(v: Duration) -> Self {
		Self::Delayed(v)
	}
}

impl From<ClockTime> for StartTime {
	fn from(v: ClockTime) -> Self {
		Self::ClockTime(v)
	}
}