Allow running web runtime in background windows #793
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit reworks the frame timing of the runtime ensuring a regular update on every frame on 60 fps monitors, while still supporting other framerates, both higher and lower. It achieves this by measuring the framerate continuously, and performing updates in a requestAnimationFrame() callback when the framerate is close to 60, but switching to a setTimeout() timing scheme otherwise. This keeps animation smooth on a 60 fps screen, but keeps updates both full-speed and at a regular 60Hz on e.g. a 30 fps screen, important for keeping tick-based audio smooth. This also has the effect of allowing you to run the runtime in a minimised or background browser window. This really improves the audio experience, allowing you to run games or music carts in the background. This also improves the netplay experience, as the game won't lag or halt any time a player clicks out of the browser window or changes tab.
The web runtime doesn't run on NodeJS, but was using node types. This was causing issues because some node types override the DOM types, e.g. `setTimeout()`. Adding `"types": []` to tsconfig.json filters out the types in `node_modules/@types` and prevents them from being used, including `node_modules/@types/node`, which is installed because it is a dependency of our dependencies.
Setting these security headers grants us access to higher precision time. This improves our ability to pace frame timings and make accurate performance measurements. I hope to take advantage of this to improve the devtools in the future.
Previously favicon.ico was being requested from wasm4.org when developing locally. This won't work if the user is offline or the website goes down, etc. It also doesn't work with secure CORS headers, as it is served from another domain.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch makes update timing more regular in various environments, including when the browser window is in the background. This allows audio and netplay to continue if the user e.g. minimises the browser window. This is achieved by switching to a setTimeout() based timing solution if the observed requestAnimationFrame rate is not a multiple of 60.
Also included are a few other relevant fixes and improvements.