line chart: better WebGL edge case handle #5465
Merged
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
bmd3k
approved these changes
Dec 15, 2021
| @@ -84,6 +84,11 @@ export interface ObjectRenderer<CacheValue = {}> { | |||
| destroyObject(cachedValue: CacheValue): void; | |||
|
|
|||
| setUseDarkMode(useDarkMode: boolean): void; | |||
|
|
|||
| /** | |||
| * Disposes rendering context. After invocation, renderer will never be used. | |||
There was a problem hiding this comment.
"will never be used" or "should never be used"?
There was a problem hiding this comment.
This is indicating to the implementer of renderer that one should expect that the renderer will no longer be used ever after dispose is called. should never be used sounds like an instruction to a user of the renderer. 🤔
I could see this jsdoc being used for both cases. Adopted your phrasing instead.
This change makes two improvements to WebGL support for the line chart. 1. Better feature detection. We now also listen to `webglcontextcreationerror` which gets emitted when browser fails to create webgl context from a canvas. This can be a good indication that user's system may not be able to handle WebGL renderer. 2. Better removal of JavaScript object. When an Angular components get scrapped, we get a chance to clean more stuff up. With the signal, we now instruct Three.js renderer to dispose all the objects more explicitly for better freeing of WebGL context + Three.js objects. There is no great way to unit test to guarantee correctness of the utility and the operation. Thus, we will leave such test to an integration test that would exercise browser capabilities. For now, we are happy with a manual functional test.
yatbear
pushed a commit
to yatbear/tensorboard
that referenced
this pull request
Mar 27, 2023
This change makes two improvements to WebGL support for the line chart. 1. Better feature detection. We now also listen to `webglcontextcreationerror` which gets emitted when browser fails to create webgl context from a canvas. This can be a good indication that user's system may not be able to handle WebGL renderer. 2. Better removal of JavaScript object. When an Angular components get scrapped, we get a chance to clean more stuff up. With the signal, we now instruct Three.js renderer to dispose all the objects more explicitly for better freeing of WebGL context + Three.js objects. There is no great way to unit test to guarantee correctness of the utility and the operation. Thus, we will leave such test to an integration test that would exercise browser capabilities. For now, we are happy with a manual functional test.
dna2github
pushed a commit
to dna2fork/tensorboard
that referenced
this pull request
May 1, 2023
This change makes two improvements to WebGL support for the line chart. 1. Better feature detection. We now also listen to `webglcontextcreationerror` which gets emitted when browser fails to create webgl context from a canvas. This can be a good indication that user's system may not be able to handle WebGL renderer. 2. Better removal of JavaScript object. When an Angular components get scrapped, we get a chance to clean more stuff up. With the signal, we now instruct Three.js renderer to dispose all the objects more explicitly for better freeing of WebGL context + Three.js objects. There is no great way to unit test to guarantee correctness of the utility and the operation. Thus, we will leave such test to an integration test that would exercise browser capabilities. For now, we are happy with a manual functional test.
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.
This change makes two improvements to WebGL support for the line chart.
webglcontextcreationerrorwhich gets emitted when browser fails tocreate webgl context from a canvas. This can be a good indication
that user's system may not be able to handle WebGL renderer.
scrapped, we get a chance to clean more stuff up. With the signal, we
now instruct Three.js renderer to dispose all the objects more
explicitly for better freeing of WebGL context + Three.js objects.
There is no great way to unit test to guarantee correctness of the
utility and the operation. Thus, we will leave such test to an
integration test that would exercise browser capabilities. For now, we
are happy with a manual functional test.