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