Skip to content

gladeye/af

Repository files navigation

AF

Simple animation frame class with read and write cycles to seperate out logic and draws to improve performance.

Reads will run before Writes.

Installation

npm install @gladeye/af

Use

As a singleton. This should be the main way this is used.

import { af } from '@gladeye/af'; // lowercase af

let count = 0;

function update(){
    count ++;
}

const animFram = af();

animFram.addRead( update );

animFramf.removeRead( update );

Or you may extend the class.

import { AF } from '@gladeye/af'; // uppercase AF

class ewAF extends AF{

}

Methods

- start()

- stop()

- addRead( fn )
    Adds function to the read cycle. These will run before the write functions

- addWrite( fn )
    Adds function to the write cycle. These will run after the read functions

- removeRead( fn )
    Removes function from the read cycle

- removeWrite( fn )
    Removes function from the write cycle

- onNextRead( fn )
    Adds function to run once on the next read cycle

- onNextWrite( fn )
    Adds function to run once on the next write cycle

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published