adds Entity docstrings #167228

gaaclarke · 2025-04-15T20:50:16Z

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

flutter-dashboard · 2025-04-15T20:50:19Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

flar

Just a 1-word nit that I'll leave to you, but otherwise looks good.

flar · 2025-04-16T16:18:53Z

engine/src/flutter/impeller/entity/entity.h


+/// Represents a renderable object within the Impeller scene.
+///
+/// An Entity combines geometry or graphical content (`Contents`) with


geometry "and" graphical content? I think of it as Contents is itself the kind of pixel data we want to paint with and it also holds the geometry via a Geometry object - so it has both?

jim feedback

auto-submit · 2025-04-16T18:20:08Z

autosubmit label was removed for flutter/flutter/167228, because - The status or check suite Windows tool_integration_tests_2_9 has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2025-04-16T22:28:04Z

autosubmit label was removed for flutter/flutter/167228, because - The status or check suite Linux tool_integration_tests_7_7 has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2025-04-16T22:52:17Z

autosubmit label was removed for flutter/flutter/167228, because - The status or check suite Mac mac_unopt has failed. Please fix the issues identified (or deflake) before re-applying this label.

flutter/flutter@ecabb1a...3ed38e2 2025-04-18 [email protected] Update `led` docs (flutter/flutter#167380) 2025-04-18 [email protected] Throw an error if --local-engine-host is used without --local-engine (flutter/flutter#166948) 2025-04-18 [email protected] Add kotlin compatability to build file validation (flutter/flutter#167143) 2025-04-18 [email protected] Roll Skia from 844496884aa0 to 6c4595124690 (2 revisions) (flutter/flutter#167400) 2025-04-18 [email protected] Fix CarouselView crashes when initlal viewportDimension is 0.0 (flutter/flutter#167271) 2025-04-18 [email protected] Roll Dart SDK from b1eb743f97f5 to ab60afc99bcb (1 revision) (flutter/flutter#167396) 2025-04-18 [email protected] Add InputDecoration.visualDensity and InputDecorationTheme.visualDensity (flutter/flutter#166834) 2025-04-18 [email protected] Roll Skia from acc910544da7 to 844496884aa0 (1 revision) (flutter/flutter#167389) 2025-04-18 [email protected] Roll Skia from a409d685a711 to acc910544da7 (10 revisions) (flutter/flutter#167388) 2025-04-18 [email protected] Roll Dart SDK from 2bb85834e77e to b1eb743f97f5 (2 revisions) (flutter/flutter#167387) 2025-04-18 [email protected] Roll Fuchsia Linux SDK from m8Aln7fTF_8zy1V9N... to MwYckh5OvwwmIYLx0... (flutter/flutter#167385) 2025-04-17 [email protected] Roll Skia from cc2b57434651 to a409d685a711 (3 revisions) (flutter/flutter#167347) 2025-04-17 [email protected] Reduce app startup latency by initializing the engine on a separate thread (flutter/flutter#166918) 2025-04-17 [email protected] Roll Dart SDK from 992221a362ec to 2bb85834e77e (7 revisions) (flutter/flutter#167361) 2025-04-17 [email protected] Added docstring for FilterInput::GetSnapshot (flutter/flutter#167226) 2025-04-17 [email protected] adds Entity docstrings (flutter/flutter#167228) 2025-04-17 [email protected] fixed impeller golden content scale (flutter/flutter#167308) 2025-04-17 [email protected] Added docstring for FilterContents::RenderFilter (flutter/flutter#167227) 2025-04-17 [email protected] Feat: Add equality to NoDefaultCupertinoThemeData (flutter/flutter#166655) 2025-04-17 [email protected] Fix link to engine docs (flutter/flutter#167346) 2025-04-17 [email protected] [macOS] Enable merged platform and UI thread by default (flutter/flutter#166536) 2025-04-17 [email protected] [Windows] Enable merged platform and UI thread by default (flutter/flutter#163726) 2025-04-17 [email protected] Update `CHANGELOG.md` (flutter/flutter#167225) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…r#9114) flutter/flutter@ecabb1a...3ed38e2 2025-04-18 [email protected] Update `led` docs (flutter/flutter#167380) 2025-04-18 [email protected] Throw an error if --local-engine-host is used without --local-engine (flutter/flutter#166948) 2025-04-18 [email protected] Add kotlin compatability to build file validation (flutter/flutter#167143) 2025-04-18 [email protected] Roll Skia from 844496884aa0 to 6c4595124690 (2 revisions) (flutter/flutter#167400) 2025-04-18 [email protected] Fix CarouselView crashes when initlal viewportDimension is 0.0 (flutter/flutter#167271) 2025-04-18 [email protected] Roll Dart SDK from b1eb743f97f5 to ab60afc99bcb (1 revision) (flutter/flutter#167396) 2025-04-18 [email protected] Add InputDecoration.visualDensity and InputDecorationTheme.visualDensity (flutter/flutter#166834) 2025-04-18 [email protected] Roll Skia from acc910544da7 to 844496884aa0 (1 revision) (flutter/flutter#167389) 2025-04-18 [email protected] Roll Skia from a409d685a711 to acc910544da7 (10 revisions) (flutter/flutter#167388) 2025-04-18 [email protected] Roll Dart SDK from 2bb85834e77e to b1eb743f97f5 (2 revisions) (flutter/flutter#167387) 2025-04-18 [email protected] Roll Fuchsia Linux SDK from m8Aln7fTF_8zy1V9N... to MwYckh5OvwwmIYLx0... (flutter/flutter#167385) 2025-04-17 [email protected] Roll Skia from cc2b57434651 to a409d685a711 (3 revisions) (flutter/flutter#167347) 2025-04-17 [email protected] Reduce app startup latency by initializing the engine on a separate thread (flutter/flutter#166918) 2025-04-17 [email protected] Roll Dart SDK from 992221a362ec to 2bb85834e77e (7 revisions) (flutter/flutter#167361) 2025-04-17 [email protected] Added docstring for FilterInput::GetSnapshot (flutter/flutter#167226) 2025-04-17 [email protected] adds Entity docstrings (flutter/flutter#167228) 2025-04-17 [email protected] fixed impeller golden content scale (flutter/flutter#167308) 2025-04-17 [email protected] Added docstring for FilterContents::RenderFilter (flutter/flutter#167227) 2025-04-17 [email protected] Feat: Add equality to NoDefaultCupertinoThemeData (flutter/flutter#166655) 2025-04-17 [email protected] Fix link to engine docs (flutter/flutter#167346) 2025-04-17 [email protected] [macOS] Enable merged platform and UI thread by default (flutter/flutter#166536) 2025-04-17 [email protected] [Windows] Enable merged platform and UI thread by default (flutter/flutter#163726) 2025-04-17 [email protected] Update `CHANGELOG.md` (flutter/flutter#167225) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

added entity docstrings

ca78860

github-actions bot added engine flutter/engine related. See also e: labels. e: impeller Impeller rendering backend issues and features requests labels Apr 15, 2025

gaaclarke requested review from flar and jonahwilliams April 15, 2025 20:50

flar approved these changes Apr 16, 2025

View reviewed changes

Update entity.h

d8a55ed

jim feedback

gaaclarke added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

gaaclarke added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

This comment was marked as off-topic.

Sign in to view

flutter-dashboard bot added the will affect goldens Changes to golden files label Apr 16, 2025

Merge branch 'master' into doc-clipdepth

a2d6a44

gaaclarke removed the will affect goldens Changes to golden files label Apr 16, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

gaaclarke added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 16, 2025

gaaclarke added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 17, 2025

auto-submit bot added this pull request to the merge queue Apr 17, 2025

Merged via the queue into flutter:master with commit df5dfdb Apr 17, 2025
180 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 17, 2025

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

602ee7a

engine-flutter-autoroll mentioned this pull request Apr 18, 2025

Roll Flutter from ecabb1a05212 to d20300874123 (20 revisions) flutter/packages#9111

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

2f32405

engine-flutter-autoroll mentioned this pull request Apr 18, 2025

Roll Flutter from ecabb1a05212 to f20bc39cc005 (21 revisions) flutter/packages#9113

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

f957684

engine-flutter-autoroll mentioned this pull request Apr 18, 2025

Roll Flutter from ecabb1a05212 to 3ed38e24528a (23 revisions) flutter/packages#9114

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

a833693

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

edd1a6b

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

6776a40

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

12904ad

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

df5dfdba6 adds Entity docstrings (flutter/flutter#167228)

521883b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

adds Entity docstrings #167228

adds Entity docstrings #167228

Uh oh!

gaaclarke commented Apr 15, 2025

Uh oh!

flutter-dashboard bot commented Apr 15, 2025

Uh oh!

flar left a comment

Uh oh!

flar Apr 16, 2025

Uh oh!

gaaclarke Apr 16, 2025 •

edited

Loading

Uh oh!

auto-submit bot commented Apr 16, 2025

Uh oh!

This comment was marked as off-topic.

auto-submit bot commented Apr 16, 2025

Uh oh!

auto-submit bot commented Apr 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

adds Entity docstrings #167228

adds Entity docstrings #167228

Uh oh!

Conversation

gaaclarke commented Apr 15, 2025

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Apr 15, 2025

Uh oh!

flar left a comment

Choose a reason for hiding this comment

Uh oh!

flar Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

gaaclarke Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Apr 16, 2025

Uh oh!

This comment was marked as off-topic.

auto-submit bot commented Apr 16, 2025

Uh oh!

auto-submit bot commented Apr 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gaaclarke Apr 16, 2025 •

edited

Loading