Skip to content
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

Add docs for More debugging options in DevTools #6975

Merged
merged 7 commits into from
Apr 4, 2022
Merged

Add docs for More debugging options in DevTools #6975

merged 7 commits into from
Apr 4, 2022

Conversation

johnpryan
Copy link
Contributor

@johnpryan johnpryan commented Mar 30, 2022

This adds documentation for the "More debugging options" in Devtools.

cc: @kenzieschmoll

fixes #6750

Presubmit checklist

![Screenshot of track paints]({{site.url}}/assets/images/docs/tools/devtools/track-paints.png)

## More debugging options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a note that users will have to reproduce activity in their app to see differences in performance

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a couple of paragraphs

reproduce the activity in your app,
select the new frames in the frames chart,
to inspect the timeline events
with the layers disabled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add a sentence here that says. "If Paint time or Raster time has significantly decreased, excessive use of the effects you disabled may be contributing to the jank you saw in your app."

@dnfield can you check me here - if a user disables clip layers and sees a performance improvement, where is that improvement likely to show up? In the Paint event on the UI thread? In the raster events?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Raster.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @dnfield . and is this true for all the layer options here? (clip, opacity, physical shape)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, yes - although some build time improvements on the UI thread may be noted, these are things that have more impact on raster time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(i.e. clipping (especially clipping with anti-aliasing if it is requested), saving layers, drawing shadows)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a sentence for this in fe1a818

Add a sentence to clarify that raster time
is mostly affected when layers are disabled in DevTools
Copy link
Member

@kenzieschmoll kenzieschmoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one small tweak, then lgtm

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like one more small tweak is needed (paint or raster => raster), then LGTM

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few little format/word things, but otherwise LGTM

@sfshaza2 sfshaza2 merged commit 78025a9 into flutter:main Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add debugging options docs
5 participants