@roukara/ticker

A simple animation loop.

Install

npm i @roukara/ticker

import Ticker from '@roukara/ticker'

or

<script src="https://unpkg.com/@roukara/ticker"></script>

Usage

const ticker = new Ticker();

function raf({ fps, deltaTime, ratio, elapsedTime }) {
  // will be called on every frame
}

const id = ticker.add(raf);

Option

|Option |Type |Default|Description| |---------|-------|-------|-----------| |autoStart|Boolean|true|If true, start() method will be called automatically.|

Methods

|Method|Description|Arguments| |------|-----------|---------| |start()|Start the animation loop.|| |stop()|Stop the animation loop.|| |add(callback, priority)|Adds a callback that will be called on every frame and returns its ID.|callback: Callback to execute every frame.priority: A higher number will be executed before those with lower number. Default is 0.| |remove(id)|Remove a callback by its ID.|id: A callback ID.| |dispose()|Dispose of the Resizer instance.||

Callback arguments

|Argument|Description| |-----|-----------| |fps|the current FPS.| |deltaTime|the elapsed time since the last frame.| |ratio|The ratio between the expected FPS (60 FPS) and the actual FPS. This value is usuful when FPS is above 60. If FPS is 60, ratio will be 1. If FPS is 120, ratio will be 0.5.| |elapsedTime|the elapsed time since start() method was called.|

License

ISC License