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