Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify docs on target-framerate. Fixes #4897 #4941

Merged
merged 3 commits into from
Nov 21, 2017
Merged

Conversation

kevinpschaaf
Copy link
Member

Reference Issue

Fixes #4897

@TimvdLippe
Copy link
Contributor

@davidmaxwaterman could you review this PR as well?

Copy link

@arthurevans arthurevans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Made a few optional suggestions.

* fps) to target by throttling the number of instances rendered each
* frame to not exceed the budget for the target frame rate. The
* framerate is effectively the number of `requestAnimationFrame`s that
* it tries to allow to actually fire in a given second, and it targets

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is kind of long. Maybe break sentence here: "... a given second. It does this by measuring the time between rAFs and continuously adjusting the number of items created each rAF to maintain the target framerate."

I also tried an optional rewording here to emphasize the fact that the process is ongoing rather than one-time. Totally optional if you prefer the current text.

* framerate is effectively the number of `requestAnimationFrame`s that
* it tries to allow to actually fire in a given second, and it targets
* this by empirically measuring the time between rAF's and throttling
* up/down the number of items created each `rAF`. Setting this to a
* higher number will allow lower latency and higher throughput for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will allow => allows

* higher number will allow lower latency and higher throughput for
* things like event handlers, but will result in a longer time for the
* remaining items to complete rendering.
* event handlers and other tasks, but will result in a longer time for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will result => results

@sorvell sorvell merged commit 1796c74 into master Nov 21, 2017
@sorvell sorvell deleted the 4897-kschaaf-docs branch November 21, 2017 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants