裁剪行为
概述
#Flutter 现在默认情况下*不*进行裁剪,除了少数专用小部件(例如 ClipRect
)。要覆盖不裁剪的默认设置,请在小部件构建中显式设置 clipBehavior
。
背景
#Flutter 曾经因为裁剪而运行缓慢。例如,2018 年 5 月,Flutter 示例应用基准测试的平均帧栅格化时间约为 35 毫秒,而实现流畅 60fps 渲染的预算是 16 毫秒。通过移除不必要的裁剪及其相关操作,我们实现了近 2 倍的速度提升,从每帧 35 毫秒降至每帧 17.5 毫秒。
当时与裁剪相关的最大开销是,Flutter 过去在每次裁剪后都会添加一个 saveLayer
调用(除非它是简单的轴对齐矩形裁剪),以避免 Issue 18057 中描述的边缘渗色伪影。这种行为在 Material 应用中普遍存在,通过 Card
、Chip
、Button
等小部件,导致 PhysicalShape
和 PhysicalModel
裁剪其内容。
在较旧的设备上,saveLayer
调用特别昂贵,因为它会创建一个屏幕外渲染目标,而渲染目标的切换有时会耗费约 1 毫秒。
即使没有 saveLayer
调用,裁剪仍然很昂贵,因为它会应用于所有后续绘制,直到恢复为止。因此,一次裁剪可能会减慢数百次绘制操作的性能。
除了性能问题,Flutter 还存在一些正确性问题,因为裁剪没有在单个位置进行管理和实现。在多个地方,saveLayer
被插入到错误的位置,因此它只是增加了性能成本,而没有修复任何边缘渗色伪影。
因此,我们在此重大更改中统一了 clipBehavior
的控制和实现。为了节省性能,大多数小部件的默认 clipBehavior
为 Clip.none
,除了以下情况:
ClipPath
默认为Clip.antiAlias
ClipRRect
默认为Clip.antiAlias
ClipRect
默认为Clip.hardEdge
Stack
默认为Clip.hardEdge
EditableText
默认为Clip.hardEdge
ListWheelScrollView
默认为Clip.hardEdge
SingleChildScrollView
默认为Clip.hardEdge
NestedScrollView
默认为Clip.hardEdge
ShrinkWrappingViewport
默认为Clip.hardEdge
迁移指南
#您有 4 种代码迁移选择
- 如果您的内容不需要裁剪(例如,没有任何小部件的子级超出其父级的边界),请保持您的代码不变。这很可能对您应用的整体性能产生积极影响。
- 如果您需要裁剪,并且无需抗锯齿裁剪对您(和您的客户)来说已经足够好,请添加
clipBehavior: Clip.hardEdge
。这通常发生在裁剪矩形或具有非常小弧形区域(例如圆角矩形的角)的形状时。 - 如果您需要抗锯齿裁剪,请添加
clipBehavior: Clip.antiAlias
。这会为您提供更平滑的边缘,但成本略高。这通常发生在处理圆形和弧形时。 - 如果您想要与之前(2018 年 5 月)完全相同的行为,请添加
clip.antiAliasWithSaveLayer
。请注意,它的性能开销非常大。这可能很少需要。您可能需要它的一个情况是,如果您的图像叠加在非常不同的背景颜色上。在这些情况下,请考虑是否可以避免在同一个位置重叠多种颜色(例如,通过仅在图像不存在的地方显示背景颜色)。
对于 Stack
小部件,如果您之前使用 overflow: Overflow.visible
,请将其替换为 clipBehavior: Clip.none
。
对于 ListWheelViewport
小部件,如果您之前指定了 clipToSize
,请将其替换为相应的 clipBehavior
:clipToSize = false
时为 Clip.none
,clipToSize = true
时为 Clip.hardEdge
。
迁移前的代码
await tester.pumpWidget(
Directionality(
textDirection: TextDirection.ltr,
child: Center(
child: Stack(
overflow: Overflow.visible,
children: const <Widget>[
SizedBox(
width: 100,
height: 100,
),
],
),
),
),
);
迁移后的代码
await tester.pumpWidget(
Directionality(
textDirection: TextDirection.ltr,
child: Center(
child: Stack(
clipBehavior: Clip.none,
children: const <Widget>[
SizedBox(
width: 100.0,
height: 100.0,
),
],
),
),
),
);
时间线
#引入版本:多个
稳定版本:2.0.0
参考资料
#API 文档
相关问题
相关 PR
- PR 5420:移除不必要的 saveLayer
- PR 18576:向 Material 及相关小部件添加 Clip 枚举
- PR 18616:从 Dart 中移除裁剪后的 saveLayer
- PR 5647:向 ClipPath/ClipRRect 和 PhysicalShape 层添加 ClipMode
- PR 5670:向画布裁剪调用添加抗锯齿开关
- PR 5853:将裁剪模式重命名为裁剪行为
- PR 5868:在 compositing.dart 中将 clip 重命名为 clipBehavior
- PR 5973:如果存在裁剪,调用 drawPaint 而非 drawPath
- PR 5952:如果可能,不带裁剪调用 drawPath
- PR 20205:将默认 clipBehavior 设置为 Clip.none 并更新测试
- PR 20538:向更多 Material 按钮公开 clipBehavior
- PR 20751:向 InkWell 添加 customBorder 以便其可以裁剪 ShapeBorder
- PR 20752:再次将默认裁剪设置为 Clip.none
- PR 21012:向更多按钮添加默认不裁剪测试
- PR 21703:将 ClipRect 的默认 clipBehavior 设置为 hardEdge
- PR 21826:ClipRectLayer 缺少默认的 hardEdge 裁剪