Struct ClockTime

pub struct ClockTime {
    pub clock: ClockId,
    pub ticks: u64,
    pub fraction: f64,
}

Available on crate feature dep_kira only.

An instant in time associated with a clock.

ClockTimes implement PartialOrd. They can be compared as long as both times are associated with the same clock. If the clocks are different, a.cmp(b) will return None.

Fields

clock: ClockId

The clock this time is associated with.

ticks: u64

The elapsed time in whole ticks.

fraction: f64

The amount of time since the last tick as a fraction of a tick.

This will always be in the range of 0.0 (inclusive) to 1.0 (exclusive).

Implementations

impl ClockTime

pub fn from_ticks_u64(clock: impl Into<ClockId>, ticks: u64) -> ClockTime

Creates a ClockTime for a clock with the specified number of whole ticks.

Example

use kira::{
	AudioManager,
	AudioManagerSettings,
	DefaultBackend,
	clock::{ClockSpeed, ClockTime},
};

let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let clock = manager.add_clock(ClockSpeed::TicksPerMinute(120.0))?;
assert_eq!(
	ClockTime::from_ticks_u64(&clock, 3),
	ClockTime {
		clock: clock.id(),
		ticks: 3,
		fraction: 0.0,
	},
);

pub fn from_ticks_f64(clock: impl Into<ClockId>, ticks: f64) -> ClockTime

Creates a ClockTime for a clock with the specified number of ticks.

Example

use kira::{
	AudioManager,
	AudioManagerSettings,
	DefaultBackend,
	clock::{ClockSpeed, ClockTime},
};

let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let clock = manager.add_clock(ClockSpeed::TicksPerMinute(120.0))?;
assert_eq!(
	ClockTime::from_ticks_f64(&clock, 3.5),
	ClockTime {
		clock: clock.id(),
		ticks: 3,
		fraction: 0.5,
	},
);

Trait Implementations

impl Add<f64> for ClockTime

type Output = ClockTime

The resulting type after applying the + operator.

fn add(self, ticks: f64) -> <ClockTime as Add<f64>>::Output

Performs the + operation.

impl Add<u64> for ClockTime

type Output = ClockTime

The resulting type after applying the + operator.

fn add(self, ticks: u64) -> <ClockTime as Add<u64>>::Output

Performs the + operation.

impl AddAssign<f64> for ClockTime

fn add_assign(&mut self, ticks: f64)

Performs the += operation.

impl AddAssign<u64> for ClockTime

fn add_assign(&mut self, ticks: u64)

Performs the += operation.

impl Clone for ClockTime

fn clone(&self) -> ClockTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClockTime

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

Formats the value using the given formatter.

impl From<ClockTime> for StartTime

fn from(v: ClockTime) -> StartTime

Converts to this type from the input type.

impl PartialEq for ClockTime

fn eq(&self, other: &ClockTime) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ClockTime

fn partial_cmp(&self, other: &ClockTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<f64> for ClockTime

type Output = ClockTime

The resulting type after applying the - operator.

fn sub(self, ticks: f64) -> <ClockTime as Sub<f64>>::Output

Performs the - operation.

impl Sub<u64> for ClockTime

type Output = ClockTime

The resulting type after applying the - operator.

fn sub(self, ticks: u64) -> <ClockTime as Sub<u64>>::Output

Performs the - operation.

impl SubAssign<f64> for ClockTime

fn sub_assign(&mut self, ticks: f64)

Performs the -= operation.

impl SubAssign<u64> for ClockTime

fn sub_assign(&mut self, ticks: u64)

Performs the -= operation.

impl Copy for ClockTime

impl StructuralPartialEq for ClockTime