Make compositing updates incremental
[WebKit-https.git] / Source / WebCore / rendering / RenderLayerBacking.h
1 /*
2  * Copyright (C) 2009, 2010, 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "FloatPoint.h"
29 #include "FloatPoint3D.h"
30 #include "GraphicsLayer.h"
31 #include "GraphicsLayerClient.h"
32 #include "RenderLayer.h"
33 #include "ScrollingCoordinator.h"
34
35 namespace WebCore {
36
37 class KeyframeList;
38 class PaintedContentsInfo;
39 class RenderLayerCompositor;
40 class TiledBacking;
41 class TransformationMatrix;
42
43 enum CompositingLayerType {
44     NormalCompositingLayer, // non-tiled layer with backing store
45     TiledCompositingLayer, // tiled layer (always has backing store)
46     MediaCompositingLayer, // layer that contains an image, video, webGL or plugin
47     ContainerCompositingLayer // layer with no backing store
48 };
49
50 // RenderLayerBacking controls the compositing behavior for a single RenderLayer.
51 // It holds the various GraphicsLayers, and makes decisions about intra-layer rendering
52 // optimizations.
53 // 
54 // There is one RenderLayerBacking for each RenderLayer that is composited.
55
56 class RenderLayerBacking final : public GraphicsLayerClient {
57     WTF_MAKE_NONCOPYABLE(RenderLayerBacking); WTF_MAKE_FAST_ALLOCATED;
58 public:
59     explicit RenderLayerBacking(RenderLayer&);
60     ~RenderLayerBacking();
61
62 #if PLATFORM(IOS_FAMILY)
63     void layerWillBeDestroyed();
64 #endif
65
66     RenderLayer& owningLayer() const { return m_owningLayer; }
67
68     void updateConfigurationAfterStyleChange();
69
70     // Returns true if layer configuration changed.
71     bool updateConfiguration();
72
73     // Update graphics layer position and bounds.
74     void updateGeometry();
75
76     // Update state the requires that descendant layers have been updated.
77     void updateAfterDescendants();
78
79     // Update contents and clipping structure.
80     void updateDrawsContent();
81     
82     void updateAfterLayout(bool needsFullRepaint);
83     
84     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
85
86     // Layer to clip children
87     bool hasClippingLayer() const { return (m_childContainmentLayer && !m_isFrameLayerWithTiledBacking); }
88     GraphicsLayer* clippingLayer() const { return !m_isFrameLayerWithTiledBacking ? m_childContainmentLayer.get() : nullptr; }
89
90     // Layer to get clipped by ancestor
91     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != nullptr; }
92     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
93
94     GraphicsLayer* contentsContainmentLayer() const { return m_contentsContainmentLayer.get(); }
95
96     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
97     GraphicsLayer* backgroundLayer() const { return m_backgroundLayer.get(); }
98     bool backgroundLayerPaintsFixedRootBackground() const { return m_backgroundLayerPaintsFixedRootBackground; }
99
100     bool requiresBackgroundLayer() const { return m_requiresBackgroundLayer; }
101     void setRequiresBackgroundLayer(bool);
102     
103     bool hasScrollingLayer() const { return m_scrollingLayer != nullptr; }
104     GraphicsLayer* scrollingLayer() const { return m_scrollingLayer.get(); }
105     GraphicsLayer* scrollingContentsLayer() const { return m_scrollingContentsLayer.get(); }
106
107     void detachFromScrollingCoordinator(OptionSet<LayerScrollCoordinationRole>);
108     
109     ScrollingNodeID scrollingNodeIDForRole(LayerScrollCoordinationRole role) const
110     {
111         switch (role) {
112         case Scrolling:
113             return m_scrollingNodeID;
114         case ViewportConstrained:
115             return m_viewportConstrainedNodeID;
116         }
117         return 0;
118     }
119     
120     void setScrollingNodeIDForRole(ScrollingNodeID nodeID, LayerScrollCoordinationRole role)
121     {
122         switch (role) {
123         case Scrolling:
124             m_scrollingNodeID = nodeID;
125             break;
126         case ViewportConstrained:
127             m_viewportConstrainedNodeID = nodeID;
128             setIsScrollCoordinatedWithViewportConstrainedRole(nodeID);
129             break;
130         }
131     }
132     
133     ScrollingNodeID scrollingNodeIDForChildren() const { return m_scrollingNodeID ? m_scrollingNodeID : m_viewportConstrainedNodeID; }
134
135     void setIsScrollCoordinatedWithViewportConstrainedRole(bool);
136
137     bool hasMaskLayer() const { return m_maskLayer; }
138     bool hasChildClippingMaskLayer() const { return m_childClippingMaskLayer != nullptr; }
139
140     GraphicsLayer* parentForSublayers() const;
141     GraphicsLayer* childForSuperlayers() const;
142
143     // RenderLayers with backing normally short-circuit paintLayer() because
144     // their content is rendered via callbacks from GraphicsLayer. However, the document
145     // layer is special, because it has a GraphicsLayer to act as a container for the GraphicsLayers
146     // for descendants, but its contents usually render into the window (in which case this returns true).
147     // This returns false for other layers, and when the document layer actually needs to paint into its backing store
148     // for some reason.
149     bool paintsIntoWindow() const;
150     
151     // Returns true for a composited layer that has no backing store of its own, so
152     // paints into some ancestor layer.
153     bool paintsIntoCompositedAncestor() const { return !m_requiresOwnBackingStore; }
154
155     void setRequiresOwnBackingStore(bool);
156
157     void setContentsNeedDisplay(GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
158     // r is in the coordinate space of the layer's render object
159     void setContentsNeedDisplayInRect(const LayoutRect&, GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
160
161     // Notification from the renderer that its content changed.
162     void contentChanged(ContentChangeType);
163
164     // Interface to start, finish, suspend and resume animations and transitions
165     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
166     void transitionPaused(double timeOffset, CSSPropertyID);
167     void transitionFinished(CSSPropertyID);
168
169     bool startAnimation(double timeOffset, const Animation* anim, const KeyframeList& keyframes);
170     void animationPaused(double timeOffset, const String& name);
171     void animationSeeked(double timeOffset, const String& name);
172     void animationFinished(const String& name);
173
174     void suspendAnimations(MonotonicTime = MonotonicTime());
175     void resumeAnimations();
176
177     LayoutRect compositedBounds() const;
178     // Returns true if changed.
179     bool setCompositedBounds(const LayoutRect&);
180     // Returns true if changed.
181     bool updateCompositedBounds();
182     
183     void updateAfterWidgetResize();
184     void positionOverflowControlsLayers();
185     
186     bool isFrameLayerWithTiledBacking() const { return m_isFrameLayerWithTiledBacking; }
187
188     WEBCORE_EXPORT TiledBacking* tiledBacking() const;
189     void adjustTiledBackingCoverage();
190     void setTiledBackingHasMargins(bool hasExtendedBackgroundOnLeftAndRight, bool hasExtendedBackgroundOnTopAndBottom);
191     
192     void updateDebugIndicators(bool showBorder, bool showRepaintCounter);
193     bool paintsSubpixelAntialiasedText() const { return m_paintsSubpixelAntialiasedText; }
194
195     // GraphicsLayerClient interface
196     void tiledBackingUsageChanged(const GraphicsLayer*, bool /*usingTiledBacking*/) override;
197     void notifyAnimationStarted(const GraphicsLayer*, const String& animationKey, MonotonicTime startTime) override;
198     void notifyFlushRequired(const GraphicsLayer*) override;
199     void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) override;
200
201     void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const FloatRect& clip, GraphicsLayerPaintBehavior) override;
202
203     float deviceScaleFactor() const override;
204     float contentsScaleMultiplierForNewTiles(const GraphicsLayer*) const override;
205
206     bool paintsOpaquelyAtNonIntegralScales(const GraphicsLayer*) const override;
207
208     float pageScaleFactor() const override;
209     float zoomedOutPageScaleFactor() const override;
210     void didCommitChangesForLayer(const GraphicsLayer*) const override;
211     bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const override;
212
213     bool isTrackingRepaints() const override;
214     bool shouldSkipLayerInDump(const GraphicsLayer*, LayerTreeAsTextBehavior) const override;
215     bool shouldDumpPropertyForLayer(const GraphicsLayer*, const char* propertyName) const override;
216
217     bool shouldAggressivelyRetainTiles(const GraphicsLayer*) const override;
218     bool shouldTemporarilyRetainTileCohorts(const GraphicsLayer*) const override;
219     bool useGiantTiles() const override;
220     void logFilledVisibleFreshTile(unsigned) override;
221     bool needsPixelAligment() const override { return !m_isMainFrameRenderViewLayer; }
222
223     LayoutSize subpixelOffsetFromRenderer() const { return m_subpixelOffsetFromRenderer; }
224
225 #if PLATFORM(IOS_FAMILY)
226     bool needsIOSDumpRenderTreeMainFrameRenderViewLayerIsAlwaysOpaqueHack(const GraphicsLayer&) const override;
227 #endif
228
229 #ifndef NDEBUG
230     void verifyNotPainting() override;
231 #endif
232
233     WEBCORE_EXPORT LayoutRect contentsBox() const;
234     
235     // For informative purposes only.
236     WEBCORE_EXPORT CompositingLayerType compositingLayerType() const;
237     
238     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
239     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
240     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
241
242     bool canCompositeFilters() const { return m_canCompositeFilters; }
243 #if ENABLE(FILTERS_LEVEL_2)
244     bool canCompositeBackdropFilters() const { return m_canCompositeBackdropFilters; }
245 #endif
246
247     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
248     WEBCORE_EXPORT double backingStoreMemoryEstimate() const;
249     
250     // For testing only.
251     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
252     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
253
254     WEBCORE_EXPORT void setIsTrackingDisplayListReplay(bool);
255     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
256
257 private:
258     friend class PaintedContentsInfo;
259
260     FloatRect backgroundBoxForSimpleContainerPainting() const;
261
262     void createPrimaryGraphicsLayer();
263     void destroyGraphicsLayers();
264     
265     void willDestroyLayer(const GraphicsLayer*);
266
267     LayoutRect compositedBoundsIncludingMargin() const;
268     
269     Ref<GraphicsLayer> createGraphicsLayer(const String&, GraphicsLayer::Type = GraphicsLayer::Type::Normal);
270
271     RenderLayerModelObject& renderer() const { return m_owningLayer.renderer(); }
272     RenderBox* renderBox() const { return m_owningLayer.renderBox(); }
273     RenderLayerCompositor& compositor() const { return m_owningLayer.compositor(); }
274
275     void updateInternalHierarchy();
276     bool updateAncestorClippingLayer(bool needsAncestorClip);
277     bool updateDescendantClippingLayer(bool needsDescendantClip);
278     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
279     bool updateForegroundLayer(bool needsForegroundLayer);
280     bool updateBackgroundLayer(bool needsBackgroundLayer);
281     void updateMaskingLayer(bool hasMask, bool hasClipPath);
282     bool requiresHorizontalScrollbarLayer() const;
283     bool requiresVerticalScrollbarLayer() const;
284     bool requiresScrollCornerLayer() const;
285     bool updateScrollingLayers(bool scrollingLayers);
286
287     void updateChildClippingStrategy(bool needsDescendantsClippingLayer);
288
289     void updateMaskingLayerGeometry();
290     
291     void updateRootLayerConfiguration();
292
293     void setBackgroundLayerPaintsFixedRootBackground(bool);
294
295     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
296     
297     LayoutSize contentOffsetInCompostingLayer() const;
298     // Result is transform origin in device pixels.
299     FloatPoint3D computeTransformOriginForPainting(const LayoutRect& borderBox) const;
300
301     void updateOpacity(const RenderStyle&);
302     void updateTransform(const RenderStyle&);
303     void updateFilters(const RenderStyle&);
304 #if ENABLE(FILTERS_LEVEL_2)
305     void updateBackdropFilters(const RenderStyle&);
306     void updateBackdropFiltersGeometry();
307 #endif
308 #if ENABLE(CSS_COMPOSITING)
309     void updateBlendMode(const RenderStyle&);
310 #endif
311     void updateCustomAppearance(const RenderStyle&);
312
313     // Return the opacity value that this layer should use for compositing.
314     float compositingOpacity(float rendererOpacity) const;
315     Color rendererBackgroundColor() const;
316
317     bool isMainFrameRenderViewLayer() const;
318     
319     bool paintsBoxDecorations() const;
320     bool paintsContent(RenderLayer::PaintedContentRequest&) const;
321
322     void updateDrawsContent(PaintedContentsInfo&);
323
324     // Returns true if this compositing layer has no visible content.
325     bool isSimpleContainerCompositingLayer(PaintedContentsInfo&) const;
326     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
327     bool containsPaintedContent(PaintedContentsInfo&) const;
328     // Returns true if the RenderLayer just contains an image that we can composite directly.
329     bool isDirectlyCompositedImage() const;
330     void updateImageContents(PaintedContentsInfo&);
331
332     void updateDirectlyCompositedBoxDecorations(PaintedContentsInfo&, bool& didUpdateContentsRect);
333     void updateDirectlyCompositedBackgroundColor(PaintedContentsInfo&, bool& didUpdateContentsRect);
334     void updateDirectlyCompositedBackgroundImage(PaintedContentsInfo&, bool& didUpdateContentsRect);
335
336     void resetContentsRect();
337
338     bool isPaintDestinationForDescendantLayers(RenderLayer::PaintedContentRequest&) const;
339     bool hasVisibleNonCompositedDescendants() const;
340
341     bool shouldClipCompositedBounds() const;
342
343     bool hasTiledBackingFlatteningLayer() const { return (m_childContainmentLayer && m_isFrameLayerWithTiledBacking); }
344     GraphicsLayer* tileCacheFlatteningLayer() const { return m_isFrameLayerWithTiledBacking ? m_childContainmentLayer.get() : nullptr; }
345
346     void paintIntoLayer(const GraphicsLayer*, GraphicsContext&, const IntRect& paintDirtyRect, OptionSet<PaintBehavior>, GraphicsLayerPaintingPhase);
347
348     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
349     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
350
351     bool canIssueSetNeedsDisplay() const { return !paintsIntoWindow() && !paintsIntoCompositedAncestor(); }
352     LayoutRect computeParentGraphicsLayerRect(RenderLayer* compositedAncestor, LayoutSize& ancestorClippingLayerOffset) const;
353     LayoutRect computePrimaryGraphicsLayerRect(const LayoutRect& parentGraphicsLayerRect) const;
354
355     RenderLayer& m_owningLayer;
356
357     RefPtr<GraphicsLayer> m_ancestorClippingLayer; // Only used if we are clipped by an ancestor which is not a stacking context.
358     RefPtr<GraphicsLayer> m_contentsContainmentLayer; // Only used if we have a background layer; takes the transform.
359     RefPtr<GraphicsLayer> m_graphicsLayer;
360     RefPtr<GraphicsLayer> m_foregroundLayer; // Only used in cases where we need to draw the foreground separately.
361     RefPtr<GraphicsLayer> m_backgroundLayer; // Only used in cases where we need to draw the background separately.
362     RefPtr<GraphicsLayer> m_childContainmentLayer; // Only used if we have clipping on a stacking context with compositing children, or if the layer has a tile cache.
363     RefPtr<GraphicsLayer> m_maskLayer; // Only used if we have a mask and/or clip-path.
364     RefPtr<GraphicsLayer> m_childClippingMaskLayer; // Only used if we have to clip child layers or accelerated contents with border radius or clip-path.
365
366     RefPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
367     RefPtr<GraphicsLayer> m_layerForVerticalScrollbar;
368     RefPtr<GraphicsLayer> m_layerForScrollCorner;
369
370     RefPtr<GraphicsLayer> m_scrollingLayer; // Only used if the layer is using composited scrolling.
371     RefPtr<GraphicsLayer> m_scrollingContentsLayer; // Only used if the layer is using composited scrolling.
372
373     LayoutRect m_compositedBounds;
374     LayoutSize m_subpixelOffsetFromRenderer; // This is the subpixel distance between the primary graphics layer and the associated renderer's bounds.
375     LayoutSize m_compositedBoundsOffsetFromGraphicsLayer; // This is the subpixel distance between the primary graphics layer and the render layer bounds.
376
377     ScrollingNodeID m_viewportConstrainedNodeID { 0 };
378     ScrollingNodeID m_scrollingNodeID { 0 };
379
380     bool m_artificiallyInflatedBounds { false }; // bounds had to be made non-zero to make transform-origin work
381     bool m_isMainFrameRenderViewLayer { false };
382     bool m_isFrameLayerWithTiledBacking { false };
383     bool m_requiresOwnBackingStore { true };
384     bool m_canCompositeFilters { false };
385 #if ENABLE(FILTERS_LEVEL_2)
386     bool m_canCompositeBackdropFilters { false };
387 #endif
388     bool m_backgroundLayerPaintsFixedRootBackground { false };
389     bool m_requiresBackgroundLayer { false };
390     bool m_paintsSubpixelAntialiasedText { false }; // This is for logging only.
391 };
392
393 enum CanvasCompositingStrategy {
394     UnacceleratedCanvas,
395     CanvasPaintedToLayer,
396     CanvasAsLayerContents
397 };
398 CanvasCompositingStrategy canvasCompositingStrategy(const RenderObject&);
399
400 WTF::TextStream& operator<<(WTF::TextStream&, const RenderLayerBacking&);
401
402 } // namespace WebCore