quark-raf 0.0.0-development

quark-raf

0.0.0-development

Raf ▸
- Instance members
- #bind
- #unbind
- #add
- #addOnce
- #remove
listenerCallback

Need help reading this?

Raf

Raf class.

new Raf()

License: https://opensource.org/licenses/MIT

Author: Patrick Heng & Fabien Motte <hengpatrick.pro@gmail.com/contact@fabienmotte.com>

Example

const callback = () => { }
Raf.add(callback)

Instance Members

▸ bind()

Bind update method.

bind()

▸ unbind()

Unbind update method and remove all listeners.

unbind()

▸ add(callback, fps, delay, once)

Add a listener.

add(callback: listenerCallback, fps: Number, delay: Number, once: Boolean): Object

Parameters

callback (listenerCallback) Listener callback.

fps

(Number
            = 60)

FPS targeted.

delay

(Number
            = 0)

Delay in milliseconds before start.

once

(Boolean
            = false)

Call once.

Returns

Object: Listener data.

▸ addOnce(callback, fps, delay)

Add once listener.

addOnce(callback: listenerCallback, fps: Number, delay: Number): Object

Parameters

callback (listenerCallback) Listener callback.

fps

(Number
            = 60)

FPS targeted.

delay

(Number
            = 0)

Delay in milliseconds before start.

Returns

Object: Listener data.

▸ remove(callback)

Remove a listener.

remove(callback: listenerCallback)

Parameters

callback (listenerCallback) Listener callback.

listenerCallback

Listener callback.

listenerCallback(delta: Number, elapsedTime: Number, now: Number)

Type: Function

Parameters

delta (Number) Delta between two frames in milliseconds.

elapsedTime (Number) Elapsed time in milliseconds since the Raf was binded.

now (Number) Current timestamp in milliseconds.