Update and rename recordFrames.md to recordAnimationFrames.md

This commit is contained in:
atomiks
2018-02-28 16:19:07 +10:00
committed by GitHub
parent 05d2c0e55b
commit c110cbff98

View File

@ -1,4 +1,4 @@
### recordFrames
### recordAnimationFrames
Invokes the provided callback on each animation frame.
@ -6,7 +6,7 @@ Use recursion. Provided that `running` is `true`, continue invoking `window.requ
provided callback. Return an object with two methods `start` and `stop` to allow manual control of the recording. Omit the second argument, `autoStart`, to implicitly call `start` when the function is invoked.
```js
const recordFrames = (callback, autoStart = true) => {
const recordAnimationFrames = (callback, autoStart = true) => {
let running = true, raf
const stop = () => {
running = false
@ -29,8 +29,8 @@ const recordFrames = (callback, autoStart = true) => {
```js
const cb = () => console.log('Animation frame fired')
const recorder = recordFrames(cb) // logs 'Animation frame fired' on each animation frame
const recorder = recordAnimationFrames(cb) // logs 'Animation frame fired' on each animation frame
recorder.stop() // stops logging
recorder.start() // starts again
const recorder2 = recordFrames(cb, false) // `start` needs to be explicitly called to begin recording frames
const recorder2 = recordAnimationFrames(cb, false) // `start` needs to be explicitly called to begin recording frames
```