Refactor composited backing-sharing code
[WebKit-https.git] / Source / WebCore / rendering / RenderLayerCompositor.h
1 /*
2  * Copyright (C) 2009, 2013 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 "ChromeClient.h"
29 #include "GraphicsLayerClient.h"
30 #include "GraphicsLayerUpdater.h"
31 #include "RenderLayer.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/OptionSet.h>
34
35 namespace WebCore {
36
37 class FixedPositionViewportConstraints;
38 class GraphicsLayer;
39 class GraphicsLayerUpdater;
40 class RenderEmbeddedObject;
41 class RenderVideo;
42 class RenderWidget;
43 class ScrollingCoordinator;
44 class StickyPositionViewportConstraints;
45 class TiledBacking;
46
47 typedef unsigned LayerTreeFlags;
48
49 enum class CompositingUpdateType {
50     AfterStyleChange,
51     AfterLayout,
52     OnScroll,
53     OnCompositedScroll
54 };
55
56 enum class CompositingReason {
57     Transform3D                            = 1 << 0,
58     Video                                  = 1 << 1,
59     Canvas                                 = 1 << 2,
60     Plugin                                 = 1 << 3,
61     IFrame                                 = 1 << 4,
62     BackfaceVisibilityHidden               = 1 << 5,
63     ClipsCompositingDescendants            = 1 << 6,
64     Animation                              = 1 << 7,
65     Filters                                = 1 << 8,
66     PositionFixed                          = 1 << 9,
67     PositionSticky                         = 1 << 10,
68     OverflowScrolling                      = 1 << 11,
69     Stacking                               = 1 << 12,
70     Overlap                                = 1 << 13,
71     OverflowScrollPositioning              = 1 << 14,
72     NegativeZIndexChildren                 = 1 << 15,
73     TransformWithCompositedDescendants     = 1 << 16,
74     OpacityWithCompositedDescendants       = 1 << 17,
75     MaskWithCompositedDescendants          = 1 << 18,
76     ReflectionWithCompositedDescendants    = 1 << 19,
77     FilterWithCompositedDescendants        = 1 << 20,
78     BlendingWithCompositedDescendants      = 1 << 21,
79     Perspective                            = 1 << 22,
80     Preserve3D                             = 1 << 23,
81     WillChange                             = 1 << 24,
82     Root                                   = 1 << 25,
83     IsolatesCompositedBlendingDescendants  = 1 << 26,
84     EmbeddedView                           = 1 << 27,
85 };
86
87 enum class ScrollCoordinationRole {
88     ViewportConstrained = 1 << 0,
89     Scrolling           = 1 << 1,
90     FrameHosting        = 1 << 2,
91     Positioning         = 1 << 3,
92 };
93
94 #if PLATFORM(IOS_FAMILY)
95 class LegacyWebKitScrollingLayerCoordinator {
96 public:
97     LegacyWebKitScrollingLayerCoordinator(ChromeClient& chromeClient, bool coordinateViewportConstrainedLayers)
98         : m_chromeClient(chromeClient)
99         , m_coordinateViewportConstrainedLayers(coordinateViewportConstrainedLayers)
100     {
101     }
102
103     void registerAllViewportConstrainedLayers(RenderLayerCompositor&);
104     void unregisterAllViewportConstrainedLayers();
105     
106     void registerAllScrollingLayers();
107     void registerScrollingLayersNeedingUpdate();
108     void unregisterAllScrollingLayers();
109     
110     void addScrollingLayer(RenderLayer&);
111     void removeScrollingLayer(RenderLayer&, RenderLayerBacking&);
112
113     void addViewportConstrainedLayer(RenderLayer&);
114     void removeViewportConstrainedLayer(RenderLayer&);
115
116     void didChangePlatformLayerForLayer(RenderLayer&);
117
118     void removeLayer(RenderLayer&);
119
120 private:
121     void updateScrollingLayer(RenderLayer&);
122
123     ChromeClient& m_chromeClient;
124
125     HashSet<RenderLayer*> m_scrollingLayers;
126     HashSet<RenderLayer*> m_viewportConstrainedLayers;
127
128     HashSet<RenderLayer*> m_scrollingLayersNeedingUpdate;
129     const bool m_coordinateViewportConstrainedLayers;
130 };
131 #endif
132
133 // RenderLayerCompositor manages the hierarchy of
134 // composited RenderLayers. It determines which RenderLayers
135 // become compositing, and creates and maintains a hierarchy of
136 // GraphicsLayers based on the RenderLayer painting order.
137 // 
138 // There is one RenderLayerCompositor per RenderView.
139
140 class RenderLayerCompositor final : public GraphicsLayerClient, public GraphicsLayerUpdaterClient {
141     WTF_MAKE_FAST_ALLOCATED;
142     friend class LegacyWebKitScrollingLayerCoordinator;
143 public:
144     explicit RenderLayerCompositor(RenderView&);
145     virtual ~RenderLayerCompositor();
146
147     // Return true if this RenderView is in "compositing mode" (i.e. has one or more
148     // composited RenderLayers)
149     bool usesCompositing() const { return m_compositing; }
150     // This will make a compositing layer at the root automatically, and hook up to
151     // the native view/window system.
152     void enableCompositingMode(bool enable = true);
153
154     bool inForcedCompositingMode() const { return m_forceCompositingMode; }
155
156     // True when some content element other than the root is composited.
157     bool hasContentCompositingLayers() const { return m_contentLayersCount; }
158
159     // Returns true if the accelerated compositing is enabled
160     bool hasAcceleratedCompositing() const { return m_hasAcceleratedCompositing; }
161
162     bool canRender3DTransforms() const;
163
164     void willRecalcStyle();
165
166     // Returns true if the composited layers were actually updated.
167     bool didRecalcStyleWithNoPendingLayout();
168
169     // GraphicsLayers buffer state, which gets pushed to the underlying platform layers
170     // at specific times.
171     void scheduleLayerFlush(bool canThrottle = false);
172     void flushPendingLayerChanges(bool isFlushRoot = true);
173
174     // Called when the GraphicsLayer for the given RenderLayer has flushed changes inside of flushPendingLayerChanges().
175     void didChangePlatformLayerForLayer(RenderLayer&, const GraphicsLayer*);
176
177     // Called when something outside WebKit affects the visible rect (e.g. delegated scrolling). Might schedule a layer flush.
178     void didChangeVisibleRect();
179     
180     // Rebuild the tree of compositing layers
181     bool updateCompositingLayers(CompositingUpdateType, RenderLayer* updateRoot = nullptr);
182     // This is only used when state changes and we do not exepect a style update or layout to happen soon (e.g. when
183     // we discover that an iframe is overlapped during painting).
184     void scheduleCompositingLayerUpdate();
185     // This is used to cancel any pending update timers when the document goes into page cache.
186     void cancelCompositingLayerUpdate();
187
188     // Update the compositing state of the given layer. Returns true if that state changed.
189     enum CompositingChangeRepaint { CompositingChangeRepaintNow, CompositingChangeWillRepaintLater };
190     enum class LayoutUpToDate {
191         Yes, No
192     };
193
194     struct RequiresCompositingData {
195         LayoutUpToDate layoutUpToDate { LayoutUpToDate::Yes };
196         RenderLayer::ViewportConstrainedNotCompositedReason nonCompositedForPositionReason { RenderLayer::NoNotCompositedReason };
197         bool reevaluateAfterLayout { false };
198     };
199
200     bool updateLayerCompositingState(RenderLayer&, RequiresCompositingData&, CompositingChangeRepaint = CompositingChangeRepaintNow);
201
202     // Whether layer's backing needs a graphics layer to do clipping by an ancestor (non-stacking-context parent with overflow).
203     bool clippedByAncestor(RenderLayer&) const;
204     // Whether layer's backing needs a graphics layer to clip z-order children of the given layer.
205     bool clipsCompositingDescendants(const RenderLayer&) const;
206
207     // Whether the given layer needs an extra 'contents' layer.
208     bool needsContentsCompositingLayer(const RenderLayer&) const;
209
210     bool fixedLayerIntersectsViewport(const RenderLayer&) const;
211
212     bool supportsFixedRootBackgroundCompositing() const;
213     bool needsFixedRootBackgroundLayer(const RenderLayer&) const;
214     GraphicsLayer* fixedRootBackgroundLayer() const;
215
216     void rootOrBodyStyleChanged(RenderElement&, const RenderStyle* oldStyle);
217
218     // Called after the view transparency, or the document or base background color change.
219     void rootBackgroundColorOrTransparencyChanged();
220     
221     // Repaint the appropriate layers when the given RenderLayer starts or stops being composited.
222     void repaintOnCompositingChange(RenderLayer&);
223     
224     void repaintInCompositedAncestor(RenderLayer&, const LayoutRect&);
225     
226     // Notify us that a layer has been added or removed
227     void layerWasAdded(RenderLayer& parent, RenderLayer& child);
228     void layerWillBeRemoved(RenderLayer& parent, RenderLayer& child);
229
230     void layerStyleChanged(StyleDifference, RenderLayer&, const RenderStyle* oldStyle);
231
232     static bool canCompositeClipPath(const RenderLayer&);
233
234     // Get the nearest ancestor layer that has overflow or clip, but is not a stacking context
235     RenderLayer* enclosingNonStackingClippingLayer(const RenderLayer&) const;
236
237     // Repaint all composited layers.
238     void repaintCompositedLayers();
239
240     // Returns true if the given layer needs it own backing store.
241     bool requiresOwnBackingStore(const RenderLayer&, const RenderLayer* compositingAncestorLayer, const LayoutRect& layerCompositedBoundsInAncestor, const LayoutRect& ancestorCompositedBounds) const;
242
243     WEBCORE_EXPORT RenderLayer& rootRenderLayer() const;
244     GraphicsLayer* rootGraphicsLayer() const;
245
246     GraphicsLayer* scrollContainerLayer() const { return m_scrollContainerLayer.get(); }
247     GraphicsLayer* scrolledContentsLayer() const { return m_scrolledContentsLayer.get(); }
248     GraphicsLayer* clipLayer() const { return m_clipLayer.get(); }
249     GraphicsLayer* rootContentsLayer() const { return m_rootContentsLayer.get(); }
250
251     GraphicsLayer* layerForClipping() const {  return m_clipLayer ? m_clipLayer.get() : m_scrollContainerLayer.get();  }
252
253 #if ENABLE(RUBBER_BANDING)
254     GraphicsLayer* headerLayer() const { return m_layerForHeader.get(); }
255     GraphicsLayer* footerLayer() const { return m_layerForFooter.get(); }
256 #endif
257
258     enum RootLayerAttachment {
259         RootLayerUnattached,
260         RootLayerAttachedViaChromeClient,
261         RootLayerAttachedViaEnclosingFrame
262     };
263
264     RootLayerAttachment rootLayerAttachment() const { return m_rootLayerAttachment; }
265     void updateRootLayerAttachment();
266     void updateRootLayerPosition();
267     
268     void setIsInWindow(bool);
269
270     void clearBackingForAllLayers();
271     
272     void layerBecameComposited(const RenderLayer&);
273     void layerBecameNonComposited(const RenderLayer&);
274     
275 #if ENABLE(VIDEO)
276     // Use by RenderVideo to ask if it should try to use accelerated compositing.
277     bool canAccelerateVideoRendering(RenderVideo&) const;
278 #endif
279
280     // Walk the tree looking for layers with 3d transforms. Useful in case you need
281     // to know if there is non-affine content, e.g. for drawing into an image.
282     bool has3DContent() const;
283     
284     static RenderLayerCompositor* frameContentsCompositor(RenderWidget&);
285     // Return true if the layers changed.
286     bool parentFrameContentLayers(RenderWidget&);
287
288     // Update the geometry of the layers used for clipping and scrolling in frames.
289     void frameViewDidChangeLocation(const IntPoint& contentsOffset);
290     void frameViewDidChangeSize();
291     void frameViewDidScroll();
292     void frameViewDidAddOrRemoveScrollbars();
293     void frameViewDidLayout();
294     void rootLayerConfigurationChanged();
295
296     String layerTreeAsText(LayerTreeFlags);
297
298     float deviceScaleFactor() const override;
299     float contentsScaleMultiplierForNewTiles(const GraphicsLayer*) const override;
300     float pageScaleFactor() const override;
301     float zoomedOutPageScaleFactor() const override;
302     void didChangePlatformLayerForLayer(const GraphicsLayer*) override { }
303     void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) override;
304
305     void layerTiledBackingUsageChanged(const GraphicsLayer*, bool /*usingTiledBacking*/);
306     
307     bool acceleratedDrawingEnabled() const { return m_acceleratedDrawingEnabled; }
308     bool displayListDrawingEnabled() const { return m_displayListDrawingEnabled; }
309
310     void deviceOrPageScaleFactorChanged();
311
312     void windowScreenDidChange(PlatformDisplayID);
313
314     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
315     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
316     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
317 #if ENABLE(RUBBER_BANDING)
318     GraphicsLayer* layerForOverhangAreas() const { return m_layerForOverhangAreas.get(); }
319     GraphicsLayer* layerForContentShadow() const { return m_contentShadowLayer.get(); }
320
321     GraphicsLayer* updateLayerForTopOverhangArea(bool wantsLayer);
322     GraphicsLayer* updateLayerForBottomOverhangArea(bool wantsLayer);
323     GraphicsLayer* updateLayerForHeader(bool wantsLayer);
324     GraphicsLayer* updateLayerForFooter(bool wantsLayer);
325 #endif
326
327     // FIXME: make the coordinated/async terminology consistent.
328     bool isViewportConstrainedFixedOrStickyLayer(const RenderLayer&) const;
329     bool useCoordinatedScrollingForLayer(const RenderLayer&) const;
330     ScrollPositioningBehavior computeCoordinatedPositioningForLayer(const RenderLayer&) const;
331     bool isLayerForIFrameWithScrollCoordinatedContents(const RenderLayer&) const;
332
333     ScrollableArea* scrollableAreaForScrollLayerID(ScrollingNodeID) const;
334
335     void removeFromScrollCoordinatedLayers(RenderLayer&);
336
337     void willRemoveScrollingLayerWithBacking(RenderLayer&, RenderLayerBacking&);
338     void didAddScrollingLayer(RenderLayer&);
339
340     void resetTrackedRepaintRects();
341     void setTracksRepaints(bool tracksRepaints) { m_isTrackingRepaints = tracksRepaints; }
342
343     bool viewHasTransparentBackground(Color* backgroundColor = nullptr) const;
344
345     bool hasNonMainLayersWithTiledBacking() const { return m_layersWithTiledBackingCount; }
346
347     OptionSet<CompositingReason> reasonsForCompositing(const RenderLayer&) const;
348
349     void setLayerFlushThrottlingEnabled(bool);
350     void disableLayerFlushThrottlingTemporarilyForInteraction();
351     
352     void didPaintBacking(RenderLayerBacking*);
353
354     const Color& rootExtendedBackgroundColor() const { return m_rootExtendedBackgroundColor; }
355
356     void updateRootContentLayerClipping();
357
358 #if ENABLE(CSS_SCROLL_SNAP)
359     void updateScrollSnapPropertiesWithFrameView(const FrameView&) const;
360 #endif
361
362     // For testing.
363     void startTrackingLayerFlushes() { m_layerFlushCount = 0; }
364     unsigned layerFlushCount() const { return m_layerFlushCount; }
365
366     void startTrackingCompositingUpdates() { m_compositingUpdateCount = 0; }
367     unsigned compositingUpdateCount() const { return m_compositingUpdateCount; }
368
369 private:
370     class BackingSharingState;
371     class OverlapMap;
372     struct CompositingState;
373     struct OverlapExtent;
374
375     // Returns true if the policy changed.
376     bool updateCompositingPolicy();
377     
378     // GraphicsLayerClient implementation
379     void notifyFlushRequired(const GraphicsLayer*) override;
380     void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const FloatRect&, GraphicsLayerPaintBehavior) override;
381     void customPositionForVisibleRectComputation(const GraphicsLayer*, FloatPoint&) const override;
382     bool isTrackingRepaints() const override { return m_isTrackingRepaints; }
383     
384     // GraphicsLayerUpdaterClient implementation
385     void flushLayersSoon(GraphicsLayerUpdater&) override;
386
387     // Copy the accelerated compositing related flags from Settings
388     void cacheAcceleratedCompositingFlags();
389     void cacheAcceleratedCompositingFlagsAfterLayout();
390
391     // Whether the given RL needs a compositing layer.
392     bool needsToBeComposited(const RenderLayer&, RequiresCompositingData&) const;
393     // Whether the layer has an intrinsic need for compositing layer.
394     bool requiresCompositingLayer(const RenderLayer&, RequiresCompositingData&) const;
395     // Whether the layer could ever be composited.
396     bool canBeComposited(const RenderLayer&) const;
397     bool needsCompositingUpdateForStyleChangeOnNonCompositedLayer(RenderLayer&, const RenderStyle* oldStyle) const;
398
399     // Make or destroy the backing for this layer; returns true if backing changed.
400     enum class BackingRequired { No, Yes, Unknown };
401     bool updateBacking(RenderLayer&, RequiresCompositingData&, CompositingChangeRepaint shouldRepaint, BackingRequired = BackingRequired::Unknown);
402
403     void clearBackingForLayerIncludingDescendants(RenderLayer&);
404
405     // Repaint this and its child layers.
406     void recursiveRepaintLayer(RenderLayer&);
407
408     void computeExtent(const OverlapMap&, const RenderLayer&, OverlapExtent&) const;
409     void addToOverlapMap(OverlapMap&, const RenderLayer&, OverlapExtent&);
410     void addToOverlapMapRecursive(OverlapMap&, const RenderLayer&, const RenderLayer* ancestorLayer = nullptr);
411
412     void updateCompositingLayersTimerFired();
413
414     void computeCompositingRequirements(RenderLayer* ancestorLayer, RenderLayer&, OverlapMap&, CompositingState&, BackingSharingState&, bool& descendantHas3DTransform);
415     void traverseUnchangedSubtree(RenderLayer* ancestorLayer, RenderLayer&, OverlapMap&, CompositingState&, BackingSharingState&, bool& descendantHas3DTransform);
416
417     enum class UpdateLevel {
418         AllDescendants          = 1 << 0,
419         CompositedChildren      = 1 << 1,
420     };
421     // Recurses down the tree, parenting descendant compositing layers and collecting an array of child layers for the current compositing layer.
422     void updateBackingAndHierarchy(RenderLayer&, Vector<Ref<GraphicsLayer>>& childGraphicsLayersOfEnclosingLayer, struct ScrollingTreeState&, OptionSet<UpdateLevel> = { }, int depth = 0);
423
424     bool layerHas3DContent(const RenderLayer&) const;
425     bool isRunningTransformAnimation(RenderLayerModelObject&) const;
426
427     void appendDocumentOverlayLayers(Vector<Ref<GraphicsLayer>>&);
428
429     bool needsCompositingForContentOrOverlays() const;
430
431     void ensureRootLayer();
432     void destroyRootLayer();
433
434     void attachRootLayer(RootLayerAttachment);
435     void detachRootLayer();
436     
437     void rootLayerAttachmentChanged();
438
439     void updateOverflowControlsLayers();
440
441     void updateScrollLayerPosition();
442     void updateScrollLayerClipping();
443
444     FloatPoint positionForClipLayer() const;
445
446     void notifyIFramesOfCompositingChange();
447
448 #if PLATFORM(IOS_FAMILY)
449     void updateScrollCoordinatedLayersAfterFlushIncludingSubframes();
450     void updateScrollCoordinatedLayersAfterFlush();
451 #endif
452
453     FloatRect visibleRectForLayerFlushing() const;
454     
455     Page& page() const;
456     
457     GraphicsLayerFactory* graphicsLayerFactory() const;
458     ScrollingCoordinator* scrollingCoordinator() const;
459
460 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
461     RefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const override;
462 #endif
463
464     // Non layout-dependent
465     bool requiresCompositingForAnimation(RenderLayerModelObject&) const;
466     bool requiresCompositingForTransform(RenderLayerModelObject&) const;
467     bool requiresCompositingForBackfaceVisibility(RenderLayerModelObject&) const;
468     bool requiresCompositingForVideo(RenderLayerModelObject&) const;
469     bool requiresCompositingForCanvas(RenderLayerModelObject&) const;
470     bool requiresCompositingForFilters(RenderLayerModelObject&) const;
471     bool requiresCompositingForWillChange(RenderLayerModelObject&) const;
472
473     // Layout-dependent
474     bool requiresCompositingForPlugin(RenderLayerModelObject&, RequiresCompositingData&) const;
475     bool requiresCompositingForFrame(RenderLayerModelObject&, RequiresCompositingData&) const;
476     bool requiresCompositingForScrollableFrame(RequiresCompositingData&) const;
477     bool requiresCompositingForPosition(RenderLayerModelObject&, const RenderLayer&, RequiresCompositingData&) const;
478     bool requiresCompositingForOverflowScrolling(const RenderLayer&, RequiresCompositingData&) const;
479     bool requiresCompositingForEditableImage(RenderLayerModelObject&) const;
480     bool requiresCompositingForIndirectReason(const RenderLayer&, const RenderLayer* compositingAncestor, bool hasCompositedDescendants, bool has3DTransformedDescendants, bool paintsIntoProvidedBacking, RenderLayer::IndirectCompositingReason&) const;
481
482     static bool layerContainingBlockCrossesCoordinatedScrollingBoundary(const RenderLayer&, const RenderLayer& compositedAncestor);
483
484     static bool styleChangeMayAffectIndirectCompositingReasons(const RenderStyle& oldStyle, const RenderStyle& newStyle);
485
486     enum class ScrollingNodeChangeFlags {
487         Layer           = 1 << 0,
488         LayerGeometry   = 1 << 1,
489     };
490
491     ScrollingNodeID attachScrollingNode(RenderLayer&, ScrollingNodeType, struct ScrollingTreeState&);
492
493     // Returns the ScrollingNodeID which acts as the parent for children.
494     ScrollingNodeID updateScrollCoordinationForLayer(RenderLayer&, struct ScrollingTreeState&, OptionSet<ScrollCoordinationRole>, OptionSet<ScrollingNodeChangeFlags>);
495
496     // These return the ScrollingNodeID which acts as the parent for children.
497     ScrollingNodeID updateScrollingNodeForViewportConstrainedRole(RenderLayer&, struct ScrollingTreeState&, OptionSet<ScrollingNodeChangeFlags>);
498     ScrollingNodeID updateScrollingNodeForScrollingRole(RenderLayer&, struct ScrollingTreeState&, OptionSet<ScrollingNodeChangeFlags>);
499     ScrollingNodeID updateScrollingNodeForFrameHostingRole(RenderLayer&, struct ScrollingTreeState&, OptionSet<ScrollingNodeChangeFlags>);
500     ScrollingNodeID updateScrollingNodeForPositioningRole(RenderLayer&, struct ScrollingTreeState&, OptionSet<ScrollingNodeChangeFlags>);
501
502     void updateScrollingNodeLayers(ScrollingNodeID, RenderLayer&, ScrollingCoordinator&);
503
504     void detachScrollCoordinatedLayer(RenderLayer&, OptionSet<ScrollCoordinationRole>);
505     void detachScrollCoordinatedLayerWithRole(RenderLayer&, ScrollingCoordinator&, ScrollCoordinationRole);
506     
507     FixedPositionViewportConstraints computeFixedViewportConstraints(RenderLayer&) const;
508     StickyPositionViewportConstraints computeStickyViewportConstraints(RenderLayer&) const;
509
510     LayoutRect rootParentRelativeScrollableRect() const;
511     LayoutRect parentRelativeScrollableRect(const RenderLayer&, const RenderLayer* ancestorLayer) const;
512
513     bool requiresScrollLayer(RootLayerAttachment) const;
514     bool requiresHorizontalScrollbarLayer() const;
515     bool requiresVerticalScrollbarLayer() const;
516     bool requiresScrollCornerLayer() const;
517 #if ENABLE(RUBBER_BANDING)
518     bool requiresOverhangAreasLayer() const;
519     bool requiresContentShadowLayer() const;
520 #endif
521
522     // True if the FrameView uses a ScrollingCoordinator.
523     bool hasCoordinatedScrolling() const;
524
525     // FIXME: make the coordinated/async terminology consistent.
526     bool isAsyncScrollableStickyLayer(const RenderLayer&, const RenderLayer** enclosingAcceleratedOverflowLayer = nullptr) const;
527
528     bool shouldCompositeOverflowControls() const;
529
530     bool isThrottlingLayerFlushes() const;
531     void startInitialLayerFlushTimerIfNeeded();
532     void startLayerFlushTimerIfNeeded();
533     void layerFlushTimerFired();
534
535 #if !LOG_DISABLED
536     const char* logReasonsForCompositing(const RenderLayer&);
537     void logLayerInfo(const RenderLayer&, const char*, int depth);
538 #endif
539
540     bool documentUsesTiledBacking() const;
541     bool isMainFrameCompositor() const;
542     
543 private:
544     RenderView& m_renderView;
545     Timer m_updateCompositingLayersTimer;
546
547     ChromeClient::CompositingTriggerFlags m_compositingTriggers { static_cast<ChromeClient::CompositingTriggerFlags>(ChromeClient::AllTriggers) };
548     bool m_hasAcceleratedCompositing { true };
549     
550     CompositingPolicy m_compositingPolicy { CompositingPolicy::Normal };
551
552     bool m_showDebugBorders { false };
553     bool m_showRepaintCounter { false };
554     bool m_acceleratedDrawingEnabled { false };
555     bool m_displayListDrawingEnabled { false };
556
557     bool m_compositing { false };
558     bool m_flushingLayers { false };
559     bool m_shouldFlushOnReattach { false };
560     bool m_forceCompositingMode { false };
561     bool m_inPostLayoutUpdate { false }; // true when it's OK to trust layout information (e.g. layer sizes and positions)
562
563     bool m_isTrackingRepaints { false }; // Used for testing.
564
565     unsigned m_contentLayersCount { 0 };
566     unsigned m_layersWithTiledBackingCount { 0 };
567     unsigned m_layerFlushCount { 0 };
568     unsigned m_compositingUpdateCount { 0 };
569
570     RootLayerAttachment m_rootLayerAttachment { RootLayerUnattached };
571
572     RefPtr<GraphicsLayer> m_rootContentsLayer;
573
574     // Enclosing clipping layer for iframe content
575     RefPtr<GraphicsLayer> m_clipLayer;
576     RefPtr<GraphicsLayer> m_scrollContainerLayer;
577     RefPtr<GraphicsLayer> m_scrolledContentsLayer;
578
579     // Enclosing layer for overflow controls and the clipping layer
580     RefPtr<GraphicsLayer> m_overflowControlsHostLayer;
581
582     // Layers for overflow controls
583     RefPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
584     RefPtr<GraphicsLayer> m_layerForVerticalScrollbar;
585     RefPtr<GraphicsLayer> m_layerForScrollCorner;
586 #if ENABLE(RUBBER_BANDING)
587     RefPtr<GraphicsLayer> m_layerForOverhangAreas;
588     RefPtr<GraphicsLayer> m_contentShadowLayer;
589     RefPtr<GraphicsLayer> m_layerForTopOverhangArea;
590     RefPtr<GraphicsLayer> m_layerForBottomOverhangArea;
591     RefPtr<GraphicsLayer> m_layerForHeader;
592     RefPtr<GraphicsLayer> m_layerForFooter;
593 #endif
594
595     std::unique_ptr<GraphicsLayerUpdater> m_layerUpdater; // Updates tiled layer visible area periodically while animations are running.
596
597     Timer m_layerFlushTimer;
598
599     bool m_layerFlushThrottlingEnabled { false };
600     bool m_layerFlushThrottlingTemporarilyDisabledForInteraction { false };
601     bool m_hasPendingLayerFlush { false };
602     bool m_viewBackgroundIsTransparent { false };
603
604 #if !LOG_DISABLED
605     int m_rootLayerUpdateCount { 0 };
606     int m_obligateCompositedLayerCount { 0 }; // count of layer that have to be composited.
607     int m_secondaryCompositedLayerCount { 0 }; // count of layers that have to be composited because of stacking or overlap.
608     double m_obligatoryBackingStoreBytes { 0 };
609     double m_secondaryBackingStoreBytes { 0 };
610 #endif
611
612     Color m_viewBackgroundColor;
613     Color m_rootExtendedBackgroundColor;
614
615     HashMap<ScrollingNodeID, RenderLayer*> m_scrollingNodeToLayerMap;
616 #if PLATFORM(IOS_FAMILY)
617     std::unique_ptr<LegacyWebKitScrollingLayerCoordinator> m_legacyScrollingLayerCoordinator;
618 #endif
619 };
620
621 void paintScrollbar(Scrollbar*, GraphicsContext&, const IntRect& clip);
622
623 WTF::TextStream& operator<<(WTF::TextStream&, CompositingUpdateType);
624 WTF::TextStream& operator<<(WTF::TextStream&, CompositingPolicy);
625
626 } // namespace WebCore
627
628 #if ENABLE(TREE_DEBUGGING)
629 // Outside the WebCore namespace for ease of invocation from the debugger.
630 void showGraphicsLayerTreeForCompositor(WebCore::RenderLayerCompositor&);
631 #endif