Commit 0a2906b
# Improve SweepGradient and TileMode Documentation
## Description
This PR enhances the documentation for `SweepGradient` and `TileMode` to
provide clearer guidance on how angles are measured and how tile modes
affect sweep gradient rendering.
### Changes
1. **SweepGradient Documentation**:
- Clarified angle measurement in radians from the positive x-axis
- Documented angle normalization behavior for values outside [0, 2π]
- Added detailed explanations of how each `TileMode` affects rendering
outside the angular sector
2. **Gradient.sweep Constructor**:
- Improved parameter documentation
- Added a practical example showing how to create a 90-degree sweep
gradient
- Clarified the relationship between color stops and angles
3. **TileMode Documentation**:
- Added sweep gradient-specific behavior to each `TileMode` variant
- Clarified how each mode (clamp, repeated, mirror, decal) affects
rendering outside the angular sector
- Improved overall documentation structure for gradient edge behavior
## Related Issues
Fixes flutter#166206
## Testing
- Verified documentation changes by reviewing the generated API docs
- Ensured all examples compile and render as expected
## Breaking Changes
None - this is purely a documentation improvement.
## Additional Notes
The changes make it much clearer how `startAngle` and `endAngle`
interact with different `TileMode` values, which was a source of
confusion in the original issue.
## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
---------
Co-authored-by: Victor Sanni <victorsanniay@gmail.com>
1 parent 36e1db8 commit 0a2906b
File tree
2 files changed
+95
-28
lines changed- engine/src/flutter/lib/ui
- packages/flutter/lib/src/painting
2 files changed
+95
-28
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4646 | 4646 | | |
4647 | 4647 | | |
4648 | 4648 | | |
4649 | | - | |
4650 | | - | |
| 4649 | + | |
4651 | 4650 | | |
4652 | | - | |
4653 | | - | |
4654 | | - | |
4655 | | - | |
| 4651 | + | |
4656 | 4652 | | |
4657 | | - | |
4658 | | - | |
4659 | | - | |
4660 | | - | |
4661 | | - | |
4662 | | - | |
| 4653 | + | |
| 4654 | + | |
4663 | 4655 | | |
4664 | | - | |
4665 | | - | |
| 4656 | + | |
| 4657 | + | |
| 4658 | + | |
| 4659 | + | |
| 4660 | + | |
| 4661 | + | |
| 4662 | + | |
| 4663 | + | |
| 4664 | + | |
| 4665 | + | |
| 4666 | + | |
| 4667 | + | |
| 4668 | + | |
| 4669 | + | |
| 4670 | + | |
| 4671 | + | |
| 4672 | + | |
| 4673 | + | |
| 4674 | + | |
4666 | 4675 | | |
4667 | 4676 | | |
4668 | 4677 | | |
| |||
4680 | 4689 | | |
4681 | 4690 | | |
4682 | 4691 | | |
4683 | | - | |
4684 | | - | |
| 4692 | + | |
| 4693 | + | |
| 4694 | + | |
| 4695 | + | |
| 4696 | + | |
| 4697 | + | |
4685 | 4698 | | |
4686 | 4699 | | |
4687 | 4700 | | |
| |||
4697 | 4710 | | |
4698 | 4711 | | |
4699 | 4712 | | |
| 4713 | + | |
| 4714 | + | |
| 4715 | + | |
4700 | 4716 | | |
4701 | 4717 | | |
4702 | 4718 | | |
| |||
4712 | 4728 | | |
4713 | 4729 | | |
4714 | 4730 | | |
| 4731 | + | |
| 4732 | + | |
| 4733 | + | |
4715 | 4734 | | |
4716 | 4735 | | |
4717 | 4736 | | |
| |||
4724 | 4743 | | |
4725 | 4744 | | |
4726 | 4745 | | |
4727 | | - | |
4728 | | - | |
| 4746 | + | |
| 4747 | + | |
| 4748 | + | |
| 4749 | + | |
| 4750 | + | |
4729 | 4751 | | |
4730 | 4752 | | |
4731 | 4753 | | |
| |||
4933 | 4955 | | |
4934 | 4956 | | |
4935 | 4957 | | |
4936 | | - | |
4937 | | - | |
4938 | | - | |
4939 | | - | |
4940 | | - | |
4941 | | - | |
4942 | | - | |
| 4958 | + | |
| 4959 | + | |
| 4960 | + | |
| 4961 | + | |
| 4962 | + | |
| 4963 | + | |
| 4964 | + | |
| 4965 | + | |
| 4966 | + | |
| 4967 | + | |
| 4968 | + | |
| 4969 | + | |
| 4970 | + | |
| 4971 | + | |
| 4972 | + | |
| 4973 | + | |
| 4974 | + | |
4943 | 4975 | | |
4944 | 4976 | | |
4945 | 4977 | | |
4946 | 4978 | | |
| 4979 | + | |
| 4980 | + | |
| 4981 | + | |
| 4982 | + | |
| 4983 | + | |
| 4984 | + | |
| 4985 | + | |
| 4986 | + | |
| 4987 | + | |
| 4988 | + | |
| 4989 | + | |
| 4990 | + | |
4947 | 4991 | | |
4948 | 4992 | | |
4949 | 4993 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
984 | 984 | | |
985 | 985 | | |
986 | 986 | | |
| 987 | + | |
| 988 | + | |
| 989 | + | |
| 990 | + | |
| 991 | + | |
| 992 | + | |
| 993 | + | |
| 994 | + | |
987 | 995 | | |
988 | 996 | | |
989 | 997 | | |
990 | 998 | | |
991 | 999 | | |
992 | | - | |
| 1000 | + | |
| 1001 | + | |
| 1002 | + | |
| 1003 | + | |
| 1004 | + | |
| 1005 | + | |
| 1006 | + | |
| 1007 | + | |
| 1008 | + | |
993 | 1009 | | |
994 | 1010 | | |
995 | | - | |
| 1011 | + | |
996 | 1012 | | |
997 | 1013 | | |
998 | | - | |
| 1014 | + | |
| 1015 | + | |
| 1016 | + | |
| 1017 | + | |
| 1018 | + | |
| 1019 | + | |
| 1020 | + | |
| 1021 | + | |
999 | 1022 | | |
1000 | 1023 | | |
1001 | 1024 | | |
| |||
0 commit comments