Skip to content

Clock ​

Returns the current time in milliseconds.

ts
export interface Clock {
  now(): number;
}

Used by FrameBudget and ManualFrameSource.

PerformanceClock ​

Reads performance.now(). The default clock of FrameBudget.

ts
import { PerformanceClock } from "@jolly-pixel/loop";

const clock = new PerformanceClock();
clock.now();

ManualClock ​

Moves only when you tell it to. For tests.

ts
import { ManualClock } from "@jolly-pixel/loop";

const clock = new ManualClock();     // starts at 0
clock.advance(16);                   // -> 16
clock.advance(5000);                 // -> 5016
clock.set(0);                        // -> 0
MemberMeaning
new ManualClock(initialTime = 0)Starts at initialTime.
set(time): numberJumps to time, returns it.
advance(deltaMs): numberAdds deltaMs, returns the new time.