Update and rename recordFrames.md to recordAnimationFrames.md
This commit is contained in:
@ -1,4 +1,4 @@
|
|||||||
### recordFrames
|
### recordAnimationFrames
|
||||||
|
|
||||||
Invokes the provided callback on each animation frame.
|
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.
|
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
|
```js
|
||||||
const recordFrames = (callback, autoStart = true) => {
|
const recordAnimationFrames = (callback, autoStart = true) => {
|
||||||
let running = true, raf
|
let running = true, raf
|
||||||
const stop = () => {
|
const stop = () => {
|
||||||
running = false
|
running = false
|
||||||
@ -29,8 +29,8 @@ const recordFrames = (callback, autoStart = true) => {
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
const cb = () => console.log('Animation frame fired')
|
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.stop() // stops logging
|
||||||
recorder.start() // starts again
|
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
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user