Timer improvements #5800
Open
Timer improvements #5800
Conversation
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
github-actions
bot
added
code-maintenance
With this, the `CodeTimer` constructor no longer needs to be public.
The font is now monospace so that the various lines are aligned with one another. The text area is also now uneditable so it doesn't have to worry about things like tracking undo state. The major change here is that text is added to the performance window via `JTextArea#append(String)` instead of `JTextComponent#setText(String)`. The former does not require us to do string concatenation (which is expensive when the contents are large), and means the text area's document does not have to reallocate a lot of its internal state.
This makes it easier to see which part of the rendering process is responsible for which slowdowns. To make this work, `RenderHelper` can have custom prefixes set by the renderers so that we can distinguish `RenderHelper` operations coming from, say, the `FogRenderer` vs the `LightsRenderer`.
Report timer results off thread
kwvanderlinde
force-pushed
the
performance/5795-timer-improvements
branch
from
c3dacee to
42cbb6d
Compare
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.
Identify the Bug or Feature request
Resolves #5795
Description of the Change
This tackles the key points mentioned in #5795:
JTextArea#append(String)instead ofJTextComponent#setText(String), which lets us avoid string concatenations and lets the text area avoiding reallocating lots of undo and cursor tracking information.ZoneRendererin particular uses microseconds for reporting, and sets its threshold much lower at 1 microsecond.There are also a few other improvements done along the way:
GdxRendererhas updatedCodeTimerusage, i.e., works withCodeTimer.using(...)rather than managing its ownCodeTimerinstance.RenderHelper, which now supports a configurable prefix for its timers.CodeTimerencounters unbalancedstart()andend()calls, it now logs them as a warning rather than throwing an exception. A user should not be bothered by a dialog for such non-critical logic errors.CodeTimertries to stay out of the way as much as possible. Instead of doing map lookups and string formatting instart(),stop(), andincrement()calls, these instead append some information to a running list. When done with theCodeTimer, the results are compiled and reported out of band, so as not to hold up the rendering.Possible Drawbacks
CodeTimerwill have different performance characteristics, so we'll have to keep on eye on things to make sure it isn't worse in some situations.Documentation Notes
N/A
Release Notes
This change is