tree: f9e721b50f0a764616ca9e73cb13bfa94956a9c2 [path history] [tgz]
  1. BUILD.gn
  2. BackgroundImageGeometry.cpp
  3. BackgroundImageGeometry.h
  4. BlockFlowPaintInvalidator.cpp
  5. BlockFlowPaintInvalidator.h
  6. BlockFlowPainter.cpp
  7. BlockFlowPainter.h
  8. BlockPaintInvalidator.cpp
  9. BlockPaintInvalidator.h
  10. BlockPainter.cpp
  11. BlockPainter.h
  12. BoxBorderPainter.cpp
  13. BoxBorderPainter.h
  14. BoxClipper.cpp
  15. BoxClipper.h
  16. BoxDecorationData.cpp
  17. BoxDecorationData.h
  18. BoxPaintInvalidator.cpp
  19. BoxPaintInvalidator.h
  20. BoxPaintInvalidatorTest.cpp
  21. BoxPainter.cpp
  22. BoxPainter.h
  23. BoxReflectionUtils.cpp
  24. BoxReflectionUtils.h
  25. ClipPathClipper.cpp
  26. ClipPathClipper.h
  27. DetailsMarkerPainter.cpp
  28. DetailsMarkerPainter.h
  29. EllipsisBoxPainter.cpp
  30. EllipsisBoxPainter.h
  31. EmbeddedObjectPaintInvalidator.cpp
  32. EmbeddedObjectPaintInvalidator.h
  33. EmbeddedObjectPainter.cpp
  34. EmbeddedObjectPainter.h
  35. FieldsetPainter.cpp
  36. FieldsetPainter.h
  37. FileUploadControlPainter.cpp
  38. FileUploadControlPainter.h
  39. FilterEffectBuilder.cpp
  40. FilterEffectBuilder.h
  41. FilterPainter.cpp
  42. FilterPainter.h
  43. FirstMeaningfulPaintDetector.cpp
  44. FirstMeaningfulPaintDetector.h
  45. FirstMeaningfulPaintDetectorTest.cpp
  46. FloatClipRecorder.cpp
  47. FloatClipRecorder.h
  48. FramePainter.cpp
  49. FramePainter.h
  50. FrameSetPainter.cpp
  51. FrameSetPainter.h
  52. GridPainter.cpp
  53. GridPainter.h
  54. HTMLCanvasPaintInvalidator.cpp
  55. HTMLCanvasPaintInvalidator.h
  56. HTMLCanvasPainter.cpp
  57. HTMLCanvasPainter.h
  58. HTMLCanvasPainterTest.cpp
  59. ImagePainter.cpp
  60. ImagePainter.h
  61. InlineFlowBoxPainter.cpp
  62. InlineFlowBoxPainter.h
  63. InlinePainter.cpp
  64. InlinePainter.h
  65. InlineTextBoxPainter.cpp
  66. InlineTextBoxPainter.h
  67. LayerClipRecorder.cpp
  68. LayerClipRecorder.h
  69. LayerClipRecorderTest.cpp
  70. LayoutObjectDrawingRecorder.h
  71. LayoutObjectDrawingRecorderTest.cpp
  72. LineBoxListPainter.cpp
  73. LineBoxListPainter.h
  74. ListItemPainter.cpp
  75. ListItemPainter.h
  76. ListMarkerPainter.cpp
  77. ListMarkerPainter.h
  78. MediaControlsPainter.cpp
  79. MediaControlsPainter.h
  80. MultiColumnSetPainter.cpp
  81. MultiColumnSetPainter.h
  82. NinePieceImageGrid.cpp
  83. NinePieceImageGrid.h
  84. NinePieceImageGridTest.cpp
  85. NinePieceImagePainter.cpp
  86. NinePieceImagePainter.h
  87. OWNERS
  88. ObjectPaintInvalidator.cpp
  89. ObjectPaintInvalidator.h
  90. ObjectPaintInvalidatorTest.cpp
  91. ObjectPaintProperties.cpp
  92. ObjectPaintProperties.h
  93. ObjectPainter.cpp
  94. ObjectPainter.h
  95. PaintControllerPaintTest.cpp
  96. PaintControllerPaintTest.h
  97. PaintInfo.cpp
  98. PaintInfo.h
  99. PaintInfoTest.cpp
  100. PaintInvalidationCapableScrollableArea.cpp
  101. PaintInvalidationCapableScrollableArea.h
  102. PaintInvalidator.cpp
  103. PaintInvalidator.h
  104. PaintLayer.cpp
  105. PaintLayer.h
  106. PaintLayerClipper.cpp
  107. PaintLayerClipper.h
  108. PaintLayerClipperTest.cpp
  109. PaintLayerFilterInfo.cpp
  110. PaintLayerFilterInfo.h
  111. PaintLayerFragment.h
  112. PaintLayerPainter.cpp
  113. PaintLayerPainter.h
  114. PaintLayerPainterTest.cpp
  115. PaintLayerPaintingInfo.h
  116. PaintLayerScrollableArea.cpp
  117. PaintLayerScrollableArea.h
  118. PaintLayerScrollableAreaTest.cpp
  119. PaintLayerStackingNode.cpp
  120. PaintLayerStackingNode.h
  121. PaintLayerStackingNodeIterator.cpp
  122. PaintLayerStackingNodeIterator.h
  123. PaintLayerTest.cpp
  124. PaintPhase.cpp
  125. PaintPhase.h
  126. PaintPropertyTreeBuilder.cpp
  127. PaintPropertyTreeBuilder.h
  128. PaintPropertyTreeBuilderTest.cpp
  129. PaintPropertyTreePrinter.cpp
  130. PaintPropertyTreePrinter.h
  131. PaintPropertyTreePrinterTest.cpp
  132. PaintTiming.cpp
  133. PaintTiming.h
  134. PartPainter.cpp
  135. PartPainter.h
  136. PrePaintTreeWalk.cpp
  137. PrePaintTreeWalk.h
  138. README.md
  139. ReplacedPainter.cpp
  140. ReplacedPainter.h
  141. RootInlineBoxPainter.cpp
  142. RootInlineBoxPainter.h
  143. RoundedInnerRectClipper.cpp
  144. RoundedInnerRectClipper.h
  145. SVGClipPainter.cpp
  146. SVGClipPainter.h
  147. SVGContainerPainter.cpp
  148. SVGContainerPainter.h
  149. SVGFilterPainter.cpp
  150. SVGFilterPainter.h
  151. SVGForeignObjectPainter.cpp
  152. SVGForeignObjectPainter.h
  153. SVGImagePainter.cpp
  154. SVGImagePainter.h
  155. SVGInlineFlowBoxPainter.cpp
  156. SVGInlineFlowBoxPainter.h
  157. SVGInlineTextBoxPainter.cpp
  158. SVGInlineTextBoxPainter.h
  159. SVGInlineTextBoxPainterTest.cpp
  160. SVGMaskPainter.cpp
  161. SVGMaskPainter.h
  162. SVGPaintContext.cpp
  163. SVGPaintContext.h
  164. SVGRootInlineBoxPainter.cpp
  165. SVGRootInlineBoxPainter.h
  166. SVGRootPainter.cpp
  167. SVGRootPainter.h
  168. SVGShapePainter.cpp
  169. SVGShapePainter.h
  170. SVGTextPainter.cpp
  171. SVGTextPainter.h
  172. ScrollRecorder.cpp
  173. ScrollRecorder.h
  174. ScrollableAreaPainter.cpp
  175. ScrollableAreaPainter.h
  176. ScrollbarManager.cpp
  177. ScrollbarManager.h
  178. ScrollbarPainter.cpp
  179. ScrollbarPainter.h
  180. StubChromeClientForSPv2.h
  181. TableCellPainter.cpp
  182. TableCellPainter.h
  183. TableCellPainterTest.cpp
  184. TablePaintInvalidator.cpp
  185. TablePaintInvalidator.h
  186. TablePainter.cpp
  187. TablePainter.h
  188. TableRowPainter.cpp
  189. TableRowPainter.h
  190. TableSectionPainter.cpp
  191. TableSectionPainter.h
  192. TextPainter.cpp
  193. TextPainter.h
  194. TextPainterTest.cpp
  195. ThemePainter.cpp
  196. ThemePainter.h
  197. ThemePainterDefault.cpp
  198. ThemePainterDefault.h
  199. ThemePainterMac.h
  200. ThemePainterMac.mm
  201. Transform3DRecorder.cpp
  202. Transform3DRecorder.h
  203. TransformRecorder.cpp
  204. TransformRecorder.h
  205. VideoPainter.cpp
  206. VideoPainter.h
  207. VideoPainterTest.cpp
  208. ViewPainter.cpp
  209. ViewPainter.h
  210. test_data/
third_party/WebKit/Source/core/paint/README.md

Source/core/paint

This directory contains implementation of painters of layout objects. It covers the following document lifecycle states:

  • PaintInvalidation (InPaintInvalidation and PaintInvalidationClean)
  • PrePaint (InPrePaint and PrePaintClean)
  • Paint (InPaint and PaintClean)

Glossaries

Stacked elements and stacking contexts

This chapter is basically a clarification of CSS 2.1 appendix E. Elaborate description of Stacking Contexts.

Note: we use ‘element’ instead of ‘object’ in this chapter to keep consistency with the spec. We use ‘object’ in other places in this document.

According to the documentation, we can have the following types of elements that are treated in different ways during painting:

  • Stacked objects: objects that are z-ordered in stacking contexts, including:

    • Stacking contexts: elements with non-auto z-indices or other properties that affect stacking e.g. transform, opacity, blend-mode.

    • Elements that are not real stacking contexts but are treated as stacking contexts but don't manage other stacked elements. Their z-ordering are managed by real stacking contexts. They are positioned elements with z-index: auto (E.2.8 in the documentation).

      They must be managed by the enclosing stacking context as stacked elements because z-index:auto and z-index:0 are considered equal for stacking context sorting and they may interleave by DOM order.

      The difference of a stacked element of this type from a real stacking context is that it doesn't manage z-ordering of stacked descendants. These descendants are managed by the parent stacking context of this stacked element.

    “Stacked element” is not defined as a formal term in the documentation, but we found it convenient to use this term to refer to any elements participating z-index ordering in stacking contexts.

    A stacked element is represented by a PaintLayerStackingNode associated with a PaintLayer. It‘s painted as self-painting PaintLayers by PaintLayerPainter by executing all of the steps of the painting algorithm explained in the documentation for the element. When painting a stacked element of the second type, we don’t paint its stacked descendants which are managed by the parent stacking context.

  • Non-stacked pseudo stacking contexts: elements that are not stacked, but paint their descendants (excluding any stacked contents) as if they created stacking contexts. This includes

    • inline blocks, inline tables, inline-level replaced elements (E.2.7.2.1.4 in the documentation)
    • non-positioned floating elements (E.2.5 in the documentation)
    • flex items
    • grid items
    • custom scrollbar parts

    They are painted by ObjectPainter::paintAllPhasesAtomically() which executes all of the steps of the painting algorithm explained in the documentation, except ignores any descendants which are positioned or have non-auto z-index (which is achieved by skipping descendants with self-painting layers).

  • Other normal elements.

Other glossaries

  • Paint container: the parent of an object for painting, as defined by CSS2.1 spec for painting. For regular objects, this is the parent in the DOM. For stacked objects, it's the containing stacking context-inducing object.

  • Paint container chain: the chain of paint ancestors between an element and the root of the page.

  • Compositing container: an implementation detail of Blink, which uses PaintLayers to represent some layout objects. It is the ancestor along the paint ancestor chain which has a PaintLayer. Implemented in PaintLayer::compositingContainer(). Think of it as skipping intermediate normal objects and going directly to the containing stacked object.

  • Compositing container chain: same as paint chain, but for compositing container.

  • Paint invalidation container: the nearest object on the compositing container chain which is composited.

Paint invalidation

Paint invalidation marks anything that need to be painted differently from the original cached painting.

Slimming paint v1

Though described in this document, most of the actual paint invalidation code is under Source/core/layout.

Paint invalidation is a document cycle stage after compositing update and before paint. During the previous stages, objects are marked for needing paint invalidation checking if needed by style change, layout change, compositing change, etc. In paint invalidation stage, we traverse the layout tree in pre-order, crossing frame boundaries, for marked subtrees and objects and send the following information to GraphicsLayers and PaintControllers:

  • paint invalidation rects: must cover all areas that will generete different pixels.
  • invalidated display item clients: must invalidate all display item clients that will generate different display items.

PaintInvalidationState

PaintInvalidationState is an optimization used during the paint invalidation phase. Before the paint invalidation tree walk, a root PaintInvalidationState is created for the root LayoutView. During the tree walk, one PaintInvalidationState is created for each visited object based on the PaintInvalidationState passed from the parent object. It tracks the following information to provide O(1) complexity access to them if possible:

  • Paint invalidation container: Since as indicated by the definitions in [Glossaries](#Other glossaries), the paint invalidation container for stacked objects can differ from normal objects, we have to track both separately. Here is an example:

    <div style="overflow: scroll">
        <div id=A style="position: absolute"></div>
        <div id=B></div>
    </div>
    

    If the scroller is composited (for high-DPI screens for example), it is the paint invalidation container for div B, but not A.

  • Paint offset and clip rect: if possible, PaintInvalidationState accumulates paint offsets and overflow clipping rects from the paint invalidation container to provide O(1) complexity to map a point or a rect in current object‘s local space to paint invalidation container’s space. Because locations of objects are determined by their containing blocks, and the containing block for absolute-position objects differs from non-absolute, we track paint offsets and overflow clipping rects for absolute-position objects separately.

In cases that accurate accumulation of paint offsets and clipping rects is impossible, we will fall back to slow-path using LayoutObject::localToAncestorPoint() or LayoutObject::mapToVisualRectInAncestorSpace(). This includes the following cases:

  • An object has transform related property, is multi-column or has flipped blocks writing-mode, causing we can't simply accumulate paint offset for mapping a local rect to paint invalidation container;

  • An object has has filter or reflection, which needs to expand paint invalidation rect for descendants, because currently we don't include and reflection extents into visual overflow;

  • For a fixed-position object we calculate its offset using LayoutObject::localToAncestorPoint(), but map for its descendants in fast-path if no other things prevent us from doing this;

  • Because we track paint offset from the normal paint invalidation container only, if we are going to use m_paintInvalidationContainerForStackedContents and it's different from the normal paint invalidation container, we have to force slow-path because the accumulated paint offset is not usable;

  • We also stop to track paint offset and clipping rect for absolute-position objects when m_paintInvalidationContainerForStackedContents becomes different from m_paintInvalidationContainer.

Paint invalidation of texts

Texts are painted by InlineTextBoxPainter using InlineTextBox as display item client. Text backgrounds and masks are painted by InlineTextFlowPainter using InlineFlowBox as display item client. We should invalidate these display item clients when their painting will change.

LayoutInlines and LayoutTexts are marked for full paint invalidation if needed when new style is set on them. During paint invalidation, we invalidate the InlineFlowBoxs directly contained by the LayoutInline in LayoutInline::invalidateDisplayItemClients() and InlineTextBoxs contained by the LayoutText in LayoutText::invalidateDisplayItemClients(). We don't need to traverse into the subtree of InlineFlowBoxs in LayoutInline::invalidateDisplayItemClients() because the descendant InlineFlowBoxs and InlineTextBoxs will be handled by their owning LayoutInlines and LayoutTexts, respectively, when changed style is propagated.

Specialty of ::first-line

::first-line pseudo style dynamically applies to all InlineBox's in the first line in the block having ::first-line style. The actual applied style is computed from the ::first-line style and other applicable styles.

If the first line contains any LayoutInline, we compute the style from the ::first-line style and the style of the LayoutInline and apply the computed style to the first line part of the LayoutInline. In blink's style implementation, the combined first line style of LayoutInline is identified with FIRST_LINE_INHERITED pseudo ID.

The normal paint invalidation of texts doesn't work for first line because

  • ComputedStyle::visualInvalidationDiff() can't detect first line style changes;
  • The normal paint invalidation is based on whole LayoutObject's, not aware of the first line.

We have a special path for first line style change: the style system informs the layout system when the computed first-line style changes through LayoutObject::firstLineStyleDidChange(). When this happens, we invalidate all InlineBoxes in the first line.

Slimming paint v2

TODO(wangxianzhu): add details

PrePaintTreeWalk (Slimming paint v2 only)

During InPrePaint document lifecycle state, this class is called to walk the whole layout tree, beginning from the root FrameView, across frame boundaries. We do the following during the tree walk:

  • Building paint property tree: creates paint property tree nodes for special things in the layout tree, including but not limit to: overflow clip, transform, fixed-pos, animation, mask, filter, etc.

  • Paint invalidation: Not implemented yet. TODO(wangxianzhu): add details after it's implemented.

Paint result caching

PaintController holds the previous painting result as a cache of display items. If some painter would generate results same as those of the previous painting, we'll skip the painting and reuse the display items from cache.

Display item caching

When a painter would create a DrawingDisplayItem exactly the same as the display item created in the previous painting, we'll reuse the previous one instead of repainting it.

Subsequence caching

When possible, we enclose the display items that PaintLayerPainter::paintContents() generates (including display items generated by sublayers) in a pair of BeginSubsequence/EndSubsequence display items.

In a subsequence paint, if the layer would generate exactly the same display items, we'll get the whole subsequence from the cache instead of repainting them.

There are many conditions affecting

  • whether we need to generate subsequence for a PaintLayer;
  • whether we can use cached subsequence for a PaintLayer. See shouldCreateSubsequence() and shouldRepaintSubsequence() in PaintLayerPainter.cpp for the conditions.

Empty paint phase optimization

During painting, we walk the layout tree multiple times for multiple paint phases. Sometimes a layer contain nothing needing a certain paint phase and we can skip tree walk for such empty phases. Now we have optimized PaintPhaseDescendantBlockBackgroundsOnly, PaintPhaseDescendantOutlinesOnly and PaintPhaseFloat for empty paint phases.

During paint invalidation, we set the containing self-painting layer's needsPaintPhaseXXX flag if the object has something needing to be painted in the paint phase.

During painting, we check the flag before painting a paint phase and skip the tree walk if the flag is not set.

It‘s hard to clear a needsPaintPhaseXXX flag when a layer no longer needs the paint phase, so we never clear the flags. Instead, we use another set of flags (previousPaintPhaseXXXWasEmpty) to record if a painting of a phase actually produced nothing. We’ll skip the next painting of the phase if the flag is set, regardless of the corresponding needsPaintPhaseXXX flag. We will clear the previousPaintPhaseXXXWasEmpty flags when we paint with different clipping, scroll offset or interest rect from the previous paint.

We don‘t clear the previousPaintPhaseXXXWasEmpty flags when the layer is marked needsRepaint. Instead we clear the flag when the corresponding needsPaintPhaseXXX is set. This ensures that we won’t clear previousPaintPhaseXXXWasEmpty flags when unrelated things changed which won't cause the paint phases to become non-empty.

When layer structure changes, and we are not invalidate paint of the changed subtree, we need to manually update the needsPaintPhaseXXX flags. For example, if an object changes style and creates a self-painting-layer, we copy the flags from its containing self-painting layer to this layer, assuming that this layer needs all paint phases that its container self-painting layer needs.

We could update the needsPaintPhaseXXX flags in a separate tree walk, but that would regress performance of the first paint. For slimming paint v2, we can update the flags during the pre-painting tree walk to simplify the logics.