Use #pragma once in WebCore
[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 RenderLayerCompositor;
39 class TiledBacking;
40 class TransformationMatrix;
41
42 enum CompositingLayerType {
43     NormalCompositingLayer, // non-tiled layer with backing store
44     TiledCompositingLayer, // tiled layer (always has backing store)
45     MediaCompositingLayer, // layer that contains an image, video, webGL or plugin
46     ContainerCompositingLayer // layer with no backing store
47 };
48
49 // RenderLayerBacking controls the compositing behavior for a single RenderLayer.
50 // It holds the various GraphicsLayers, and makes decisions about intra-layer rendering
51 // optimizations.
52 // 
53 // There is one RenderLayerBacking for each RenderLayer that is composited.
54
55 class RenderLayerBacking final : public GraphicsLayerClient {
56     WTF_MAKE_NONCOPYABLE(RenderLayerBacking); WTF_MAKE_FAST_ALLOCATED;
57 public:
58     explicit RenderLayerBacking(RenderLayer&);
59     ~RenderLayerBacking();
60
61 #if PLATFORM(IOS)
62     void layerWillBeDestroyed();
63 #endif
64
65     RenderLayer& owningLayer() const { return m_owningLayer; }
66
67     enum UpdateAfterLayoutFlag {
68         CompositingChildrenOnly = 1 << 0,
69         NeedsFullRepaint = 1 << 1,
70         IsUpdateRoot = 1 << 2
71     };
72     typedef unsigned UpdateAfterLayoutFlags;
73     void updateAfterLayout(UpdateAfterLayoutFlags);
74     
75     // Returns true if layer configuration changed.
76     bool updateConfiguration();
77
78     // Update graphics layer position and bounds.
79     void updateGeometry();
80
81     // Update state the requires that descendant layers have been updated.
82     void updateAfterDescendants();
83
84     // Update contents and clipping structure.
85     void updateDrawsContent();
86     
87     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
88
89     // Layer to clip children
90     bool hasClippingLayer() const { return (m_childContainmentLayer && !m_usingTiledCacheLayer); }
91     GraphicsLayer* clippingLayer() const { return !m_usingTiledCacheLayer ? m_childContainmentLayer.get() : nullptr; }
92
93     // Layer to get clipped by ancestor
94     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != nullptr; }
95     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
96
97     GraphicsLayer* contentsContainmentLayer() const { return m_contentsContainmentLayer.get(); }
98
99     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
100     GraphicsLayer* backgroundLayer() const { return m_backgroundLayer.get(); }
101     bool backgroundLayerPaintsFixedRootBackground() const { return m_backgroundLayerPaintsFixedRootBackground; }
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(LayerScrollCoordinationRoles);
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 != 0; }
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 animationFinished(const String& name);
172
173     void suspendAnimations(double time = 0);
174     void resumeAnimations();
175
176     LayoutRect compositedBounds() const;
177     void setCompositedBounds(const LayoutRect&);
178     void updateCompositedBounds();
179     
180     void updateAfterWidgetResize();
181     void positionOverflowControlsLayers();
182     bool hasUnpositionedOverflowControlsLayers() const;
183
184     bool usingTiledBacking() const { return m_usingTiledCacheLayer; }
185     WEBCORE_EXPORT TiledBacking* tiledBacking() const;
186     void adjustTiledBackingCoverage();
187     void setTiledBackingHasMargins(bool hasExtendedBackgroundOnLeftAndRight, bool hasExtendedBackgroundOnTopAndBottom);
188     
189     void updateDebugIndicators(bool showBorder, bool showRepaintCounter);
190
191     // GraphicsLayerClient interface
192     void tiledBackingUsageChanged(const GraphicsLayer*, bool /*usingTiledBacking*/) override;
193     void notifyAnimationStarted(const GraphicsLayer*, const String& animationKey, double startTime) override;
194     void notifyFlushRequired(const GraphicsLayer*) override;
195     void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) override;
196
197     void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const FloatRect& clip) override;
198
199     float deviceScaleFactor() const override;
200     float contentsScaleMultiplierForNewTiles(const GraphicsLayer*) const override;
201
202     bool paintsOpaquelyAtNonIntegralScales(const GraphicsLayer*) const override;
203
204     float pageScaleFactor() const override;
205     float zoomedOutPageScaleFactor() const override;
206     void didCommitChangesForLayer(const GraphicsLayer*) const override;
207     bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const override;
208
209     bool isTrackingRepaints() const override;
210     bool shouldSkipLayerInDump(const GraphicsLayer*, LayerTreeAsTextBehavior) const override;
211     bool shouldDumpPropertyForLayer(const GraphicsLayer*, const char* propertyName) const override;
212
213     bool shouldAggressivelyRetainTiles(const GraphicsLayer*) const override;
214     bool shouldTemporarilyRetainTileCohorts(const GraphicsLayer*) const override;
215     bool useGiantTiles() const override;
216     bool needsPixelAligment() const override { return !m_isMainFrameRenderViewLayer; }
217
218     LayoutSize subpixelOffsetFromRenderer() const { return m_subpixelOffsetFromRenderer; }
219
220 #if PLATFORM(IOS)
221     bool needsIOSDumpRenderTreeMainFrameRenderViewLayerIsAlwaysOpaqueHack(const GraphicsLayer&) const override;
222 #endif
223
224 #ifndef NDEBUG
225     void verifyNotPainting() override;
226 #endif
227
228     WEBCORE_EXPORT LayoutRect contentsBox() const;
229     
230     // For informative purposes only.
231     WEBCORE_EXPORT CompositingLayerType compositingLayerType() const;
232     
233     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
234     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
235     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
236
237     bool canCompositeFilters() const { return m_canCompositeFilters; }
238 #if ENABLE(FILTERS_LEVEL_2)
239     bool canCompositeBackdropFilters() const { return m_canCompositeBackdropFilters; }
240 #endif
241
242     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
243     WEBCORE_EXPORT double backingStoreMemoryEstimate() const;
244     
245     // For testing only.
246     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
247     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
248
249     WEBCORE_EXPORT void setIsTrackingDisplayListReplay(bool);
250     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
251
252 private:
253     FloatRect backgroundBoxForSimpleContainerPainting() const;
254
255     void createPrimaryGraphicsLayer();
256     void destroyGraphicsLayers();
257     
258     void willDestroyLayer(const GraphicsLayer*);
259
260     LayoutRect compositedBoundsIncludingMargin() const;
261     
262     std::unique_ptr<GraphicsLayer> createGraphicsLayer(const String&, GraphicsLayer::Type = GraphicsLayer::Type::Normal);
263
264     RenderLayerModelObject& renderer() const { return m_owningLayer.renderer(); }
265     RenderBox* renderBox() const { return m_owningLayer.renderBox(); }
266     RenderLayerCompositor& compositor() const { return m_owningLayer.compositor(); }
267
268     void updateInternalHierarchy();
269     bool updateAncestorClippingLayer(bool needsAncestorClip);
270     bool updateDescendantClippingLayer(bool needsDescendantClip);
271     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
272     bool updateForegroundLayer(bool needsForegroundLayer);
273     bool updateBackgroundLayer(bool needsBackgroundLayer);
274     void updateMaskingLayer(bool hasMask, bool hasClipPath);
275     bool requiresHorizontalScrollbarLayer() const;
276     bool requiresVerticalScrollbarLayer() const;
277     bool requiresScrollCornerLayer() const;
278     bool updateScrollingLayers(bool scrollingLayers);
279     void updateDrawsContent(bool isSimpleContainer);
280     void updateChildClippingStrategy(bool needsDescendantsClippingLayer);
281
282     void updateMaskingLayerGeometry();
283     
284     void updateRootLayerConfiguration();
285
286     void setBackgroundLayerPaintsFixedRootBackground(bool);
287
288     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
289     
290     LayoutSize contentOffsetInCompostingLayer() const;
291     // Result is transform origin in device pixels.
292     FloatPoint3D computeTransformOriginForPainting(const LayoutRect& borderBox) const;
293
294     void updateOpacity(const RenderStyle&);
295     void updateTransform(const RenderStyle&);
296     void updateFilters(const RenderStyle&);
297 #if ENABLE(FILTERS_LEVEL_2)
298     void updateBackdropFilters(const RenderStyle&);
299     void updateBackdropFiltersGeometry();
300 #endif
301 #if ENABLE(CSS_COMPOSITING)
302     void updateBlendMode(const RenderStyle&);
303 #endif
304     void updateCustomAppearance(const RenderStyle&);
305
306     // Return the opacity value that this layer should use for compositing.
307     float compositingOpacity(float rendererOpacity) const;
308     
309     bool isMainFrameRenderViewLayer() const;
310     
311     bool paintsNonDirectCompositedBoxDecoration() const;
312     bool paintsChildren() const;
313
314     // Returns true if this compositing layer has no visible content.
315     bool isSimpleContainerCompositingLayer() const;
316     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
317     bool containsPaintedContent(bool isSimpleContainer) const;
318     // Returns true if the RenderLayer just contains an image that we can composite directly.
319     bool isDirectlyCompositedImage() const;
320     void updateImageContents();
321
322     Color rendererBackgroundColor() const;
323     void updateDirectlyCompositedBackgroundColor(bool isSimpleContainer, bool& didUpdateContentsRect);
324     void updateDirectlyCompositedBackgroundImage(bool isSimpleContainer, bool& didUpdateContentsRect);
325     void updateDirectlyCompositedContents(bool isSimpleContainer, bool& didUpdateContentsRect);
326
327     void resetContentsRect();
328
329     bool isPaintDestinationForDescendantLayers() const;
330
331     bool shouldClipCompositedBounds() const;
332
333     bool hasTiledBackingFlatteningLayer() const { return (m_childContainmentLayer && m_usingTiledCacheLayer); }
334     GraphicsLayer* tileCacheFlatteningLayer() const { return m_usingTiledCacheLayer ? m_childContainmentLayer.get() : nullptr; }
335
336     void paintIntoLayer(const GraphicsLayer*, GraphicsContext&, const IntRect& paintDirtyRect, PaintBehavior, GraphicsLayerPaintingPhase);
337
338     // Helper function for updateGeometry.
339     void adjustAncestorCompositingBoundsForFlowThread(LayoutRect& ancestorCompositingBounds, const RenderLayer* compositingAncestor) const;
340
341     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
342     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
343
344     bool canIssueSetNeedsDisplay() const { return !paintsIntoWindow() && !paintsIntoCompositedAncestor(); }
345     LayoutRect computeParentGraphicsLayerRect(RenderLayer* compositedAncestor, LayoutSize& ancestorClippingLayerOffset) const;
346     LayoutRect computePrimaryGraphicsLayerRect(const LayoutRect& parentGraphicsLayerRect) const;
347
348     RenderLayer& m_owningLayer;
349
350     std::unique_ptr<GraphicsLayer> m_ancestorClippingLayer; // Only used if we are clipped by an ancestor which is not a stacking context.
351     std::unique_ptr<GraphicsLayer> m_contentsContainmentLayer; // Only used if we have a background layer; takes the transform.
352     std::unique_ptr<GraphicsLayer> m_graphicsLayer;
353     std::unique_ptr<GraphicsLayer> m_foregroundLayer; // Only used in cases where we need to draw the foreground separately.
354     std::unique_ptr<GraphicsLayer> m_backgroundLayer; // Only used in cases where we need to draw the background separately.
355     std::unique_ptr<GraphicsLayer> m_childContainmentLayer; // Only used if we have clipping on a stacking context with compositing children, or if the layer has a tile cache.
356     std::unique_ptr<GraphicsLayer> m_maskLayer; // Only used if we have a mask and/or clip-path.
357     std::unique_ptr<GraphicsLayer> m_childClippingMaskLayer; // Only used if we have to clip child layers or accelerated contents with border radius or clip-path.
358
359     std::unique_ptr<GraphicsLayer> m_layerForHorizontalScrollbar;
360     std::unique_ptr<GraphicsLayer> m_layerForVerticalScrollbar;
361     std::unique_ptr<GraphicsLayer> m_layerForScrollCorner;
362
363     std::unique_ptr<GraphicsLayer> m_scrollingLayer; // Only used if the layer is using composited scrolling.
364     std::unique_ptr<GraphicsLayer> m_scrollingContentsLayer; // Only used if the layer is using composited scrolling.
365
366     ScrollingNodeID m_viewportConstrainedNodeID;
367     ScrollingNodeID m_scrollingNodeID;
368
369     LayoutRect m_compositedBounds;
370     LayoutSize m_subpixelOffsetFromRenderer; // This is the subpixel distance between the primary graphics layer and the associated renderer's bounds.
371     LayoutSize m_compositedBoundsOffsetFromGraphicsLayer; // This is the subpixel distance between the primary graphics layer and the render layer bounds.
372
373     bool m_artificiallyInflatedBounds; // bounds had to be made non-zero to make transform-origin work
374     bool m_isMainFrameRenderViewLayer;
375     bool m_usingTiledCacheLayer;
376     bool m_requiresOwnBackingStore;
377     bool m_canCompositeFilters;
378 #if ENABLE(FILTERS_LEVEL_2)
379     bool m_canCompositeBackdropFilters;
380 #endif
381     bool m_backgroundLayerPaintsFixedRootBackground;
382 };
383
384 enum CanvasCompositingStrategy {
385     UnacceleratedCanvas,
386     CanvasPaintedToLayer,
387     CanvasAsLayerContents
388 };
389 CanvasCompositingStrategy canvasCompositingStrategy(const RenderObject&);
390
391 } // namespace WebCore