HTML5: document host-set Module opt-outs (defold/defold#12396 follow-up)#635
Open
birdingman0626 wants to merge 1 commit into
Open
HTML5: document host-set Module opt-outs (defold/defold#12396 follow-up)#635birdingman0626 wants to merge 1 commit into
birdingman0626 wants to merge 1 commit into
Conversation
dmloader.js now respects six host-set properties on the global Module object when they're declared before <script src="dmloader.js"> loads (defold/defold#12396). Document the full surface — pthread, WebGL2, context attrs, extension filter, button strip, context-loss recovery — in the HTML5 manual under a new "Host-set Module properties" subsection, between Engine arguments and Query arguments. Includes the example shape, the per-property reference table, and the two important notes (let-vs-var binding, strict sentinel checks).
14 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Follow-up documentation for defold/defold#12396, which expands
dmloader.jsto respect six host-set properties on the globalModuleobject:Module.isWASMPthreadSupportedModule.isWebGL2SupportedModule.webGLContextAttributesModule.webGLExtensionFilterModule.showButtonStripModule.autoReloadOnWebGLContextRestoreEach is captured before the loader's own
var Module = {...}redefinition and applied in an IIFE that runs at the same site. Default behaviour is byte-identical when nothing is pre-set.This PR adds a new "Host-set Module properties" subsection to
docs/en/manuals/html5.md, placed between the existing "Engine arguments" and "Query arguments in the URL" subsections under "Passing arguments to an HTML5 game". The new content includes:var Module = { ... };block before the<script src=\"dmloader.js\">tag).letvsvarbinding gotcha (top-levellet Moduleis invisible to the loader'svar Module), and the strict sentinel-value semantics (=== false/=== true/functiontypeof, no coercion).Should land after defold/defold#12396 merges, since this references behaviour the engine doesn't have yet. Adjustable to whatever the final API surface looks like if the engine PR shrinks during review.
PR checklist