Update recordAnimationFrames.md
This commit is contained in:
@ -2,8 +2,10 @@
|
|||||||
|
|
||||||
Invokes the provided callback on each animation frame.
|
Invokes the provided callback on each animation frame.
|
||||||
|
|
||||||
Use recursion. Provided that `running` is `true`, continue invoking `window.requestAnimationFrame()` which invokes the
|
Use recursion.
|
||||||
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 that `running` is `true`, continue invoking `window.requestAnimationFrame()` which invokes the 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 recordAnimationFrames = (callback, autoStart = true) => {
|
const recordAnimationFrames = (callback, autoStart = true) => {
|
||||||
@ -28,9 +30,9 @@ const recordAnimationFrames = (callback, autoStart = true) => {
|
|||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const cb = () => console.log('Animation frame fired')
|
const cb = () => console.log('Animation frame fired');
|
||||||
const recorder = recordAnimationFrames(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 = recordAnimationFrames(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