-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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
Chore: Cleanup document for renderer options #9120
Conversation
BTW it seems that |
Yes, please remove legacy. That was used a long time ago with Android browser compatibility. Most of that is now irrelevant. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! One minor suggestion, could you alphabetize the options to make it more organized (e.g., Renderer's options
)
Oh, I meant to order them by their function (options for |
Yeah, for most people, the systems are an implementation detail they don't care about. I think alpha is more useful for the majority audience. |
I've changed the order of the options in the document to sort by alphabetical order. I keeped the order in |
Description of change
Trying to cleanup
IRendererOptions
related documents. Previously these documents were not very consistent in different places, now they are much better. Also I rewritten some of the descriptions.Document preview:
IRendererOptions
Before | AfterRenderer
Before | AfterCanvasRenderer
Before | After (- WebGL Only options)autoDetectRenderer
Before | After (+forceCanvas
)Application
Before | After (+forceCanvas
,resizeTo
,autoStart
,sharedTicker
)settings.RENDER_OPTIONS
Before | AfterAlso
settings.RENDER_OPTIONS.legacy
is removed since it is no longer being used.Fixes #8073. Cleanup for v6.x branch is in #9123.
Pre-Merge Checklist
npm run lint
)npm run test
)