Images missing sometimes with composited clipping layers
[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 #ifndef RenderLayerBacking_h
27 #define RenderLayerBacking_h
28
29 #include "FloatPoint.h"
30 #include "FloatPoint3D.h"
31 #include "GraphicsLayer.h"
32 #include "GraphicsLayerClient.h"
33 #include "RenderLayer.h"
34 #include "ScrollingCoordinator.h"
35
36 namespace WebCore {
37
38 class KeyframeList;
39 class RenderLayerCompositor;
40 class TiledBacking;
41 class TransformationMatrix;
42
43 enum CompositingLayerType {
44     NormalCompositingLayer, // non-tiled layer with backing store
45     TiledCompositingLayer, // tiled layer (always has backing store)
46     MediaCompositingLayer, // layer that contains an image, video, webGL or plugin
47     ContainerCompositingLayer // layer with no backing store
48 };
49
50 // RenderLayerBacking controls the compositing behavior for a single RenderLayer.
51 // It holds the various GraphicsLayers, and makes decisions about intra-layer rendering
52 // optimizations.
53 // 
54 // There is one RenderLayerBacking for each RenderLayer that is composited.
55
56 class RenderLayerBacking : public GraphicsLayerClient {
57     WTF_MAKE_NONCOPYABLE(RenderLayerBacking); WTF_MAKE_FAST_ALLOCATED;
58 public:
59     explicit RenderLayerBacking(RenderLayer&);
60     ~RenderLayerBacking();
61
62 #if PLATFORM(IOS)
63     void layerWillBeDestroyed();
64 #endif
65
66     RenderLayer& owningLayer() const { return m_owningLayer; }
67
68     enum UpdateAfterLayoutFlag {
69         CompositingChildrenOnly = 1 << 0,
70         NeedsFullRepaint = 1 << 1,
71         IsUpdateRoot = 1 << 2
72     };
73     typedef unsigned UpdateAfterLayoutFlags;
74     void updateAfterLayout(UpdateAfterLayoutFlags);
75     
76     // Returns true if layer configuration changed.
77     bool updateConfiguration();
78
79     // Update graphics layer position and bounds.
80     void updateGeometry();
81
82     // Update state the requires that descendant layers have been updated.
83     void updateAfterDescendents();
84
85     // Update contents and clipping structure.
86     void updateDrawsContent();
87     
88     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
89
90     // Layer to clip children
91     bool hasClippingLayer() const { return (m_childContainmentLayer && !m_usingTiledCacheLayer); }
92     GraphicsLayer* clippingLayer() const { return !m_usingTiledCacheLayer ? m_childContainmentLayer.get() : 0; }
93
94     // Layer to get clipped by ancestor
95     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != 0; }
96     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
97
98     GraphicsLayer* contentsContainmentLayer() const { return m_contentsContainmentLayer.get(); }
99
100     bool hasContentsLayer() const { return m_foregroundLayer != 0; }
101     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
102
103     GraphicsLayer* backgroundLayer() const { return m_backgroundLayer.get(); }
104     bool backgroundLayerPaintsFixedRootBackground() const { return m_backgroundLayerPaintsFixedRootBackground; }
105     
106     bool hasScrollingLayer() const { return m_scrollingLayer != nullptr; }
107     GraphicsLayer* scrollingLayer() const { return m_scrollingLayer.get(); }
108     GraphicsLayer* scrollingContentsLayer() const { return m_scrollingContentsLayer.get(); }
109
110     void detachFromScrollingCoordinator();
111
112     ScrollingNodeID viewportConstrainedNodeID() const { return m_viewportConstrainedNodeID; }
113     void setViewportConstrainedNodeID(ScrollingNodeID nodeID) { m_viewportConstrainedNodeID = nodeID; }
114
115     ScrollingNodeID scrollingNodeID() const { return m_scrollingNodeID; }
116     void setScrollingNodeID(ScrollingNodeID nodeID) { m_scrollingNodeID = nodeID; }
117     
118     ScrollingNodeID scrollingNodeIDForChildren() const { return m_scrollingNodeID ? m_scrollingNodeID : m_viewportConstrainedNodeID; }
119
120     bool hasMaskLayer() const { return m_maskLayer != 0; }
121
122     GraphicsLayer* parentForSublayers() const;
123     GraphicsLayer* childForSuperlayers() const;
124
125     // RenderLayers with backing normally short-circuit paintLayer() because
126     // their content is rendered via callbacks from GraphicsLayer. However, the document
127     // layer is special, because it has a GraphicsLayer to act as a container for the GraphicsLayers
128     // for descendants, but its contents usually render into the window (in which case this returns true).
129     // This returns false for other layers, and when the document layer actually needs to paint into its backing store
130     // for some reason.
131     bool paintsIntoWindow() const;
132     
133     // Returns true for a composited layer that has no backing store of its own, so
134     // paints into some ancestor layer.
135     bool paintsIntoCompositedAncestor() const { return !m_requiresOwnBackingStore; }
136
137     void setRequiresOwnBackingStore(bool);
138
139     void setContentsNeedDisplay(GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
140     // r is in the coordinate space of the layer's render object
141     void setContentsNeedDisplayInRect(const LayoutRect&, GraphicsLayer::ShouldClipToLayer = GraphicsLayer::ClipToLayer);
142
143     // Notification from the renderer that its content changed.
144     void contentChanged(ContentChangeType);
145
146     // Interface to start, finish, suspend and resume animations and transitions
147     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
148     void transitionPaused(double timeOffset, CSSPropertyID);
149     void transitionFinished(CSSPropertyID);
150
151     bool startAnimation(double timeOffset, const Animation* anim, const KeyframeList& keyframes);
152     void animationPaused(double timeOffset, const String& name);
153     void animationFinished(const String& name);
154
155     void suspendAnimations(double time = 0);
156     void resumeAnimations();
157
158     LayoutRect compositedBounds() const;
159     void setCompositedBounds(const LayoutRect&);
160     void updateCompositedBounds();
161     
162     void updateAfterWidgetResize();
163     void positionOverflowControlsLayers();
164     bool hasUnpositionedOverflowControlsLayers() const;
165
166     bool usingTiledBacking() const { return m_usingTiledCacheLayer; }
167     TiledBacking* tiledBacking() const;
168     void adjustTiledBackingCoverage();
169     void setTiledBackingHasMargins(bool hasExtendedBackgroundOnLeftAndRight, bool hasExtendedBackgroundOnTopAndBottom);
170     
171     void updateDebugIndicators(bool showBorder, bool showRepaintCounter);
172
173     // GraphicsLayerClient interface
174     virtual bool shouldUseTiledBacking(const GraphicsLayer*) const override;
175     virtual void tiledBackingUsageChanged(const GraphicsLayer*, bool /*usingTiledBacking*/) override;
176     virtual void notifyAnimationStarted(const GraphicsLayer*, double startTime) override;
177     virtual void notifyFlushRequired(const GraphicsLayer*) override;
178     virtual void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) override;
179
180     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const FloatRect& clip) override;
181
182     virtual float deviceScaleFactor() const override;
183     virtual float contentsScaleMultiplierForNewTiles(const GraphicsLayer*) const override;
184
185     virtual bool paintsOpaquelyAtNonIntegralScales(const GraphicsLayer*) const override;
186
187     virtual float pageScaleFactor() const override;
188     virtual float zoomedOutPageScaleFactor() const override;
189     virtual void didCommitChangesForLayer(const GraphicsLayer*) const override;
190     virtual bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const override;
191
192     virtual bool isTrackingRepaints() const override;
193     virtual bool shouldSkipLayerInDump(const GraphicsLayer*) const override;
194     virtual bool shouldDumpPropertyForLayer(const GraphicsLayer*, const char* propertyName) const override;
195
196     virtual bool shouldAggressivelyRetainTiles(const GraphicsLayer*) const override;
197     virtual bool shouldTemporarilyRetainTileCohorts(const GraphicsLayer*) const override;
198
199 #ifndef NDEBUG
200     virtual void verifyNotPainting();
201 #endif
202
203     LayoutRect contentsBox() const;
204     
205     // For informative purposes only.
206     CompositingLayerType compositingLayerType() const;
207     
208     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
209     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
210     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
211
212 #if ENABLE(CSS_FILTERS)
213     bool canCompositeFilters() const { return m_canCompositeFilters; }
214 #endif
215
216     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
217     double backingStoreMemoryEstimate() const;
218
219     LayoutSize devicePixelFractionFromRenderer() const { return m_devicePixelFractionFromRenderer; }
220
221 private:
222     FloatRect backgroundBoxForPainting() const;
223
224     void createPrimaryGraphicsLayer();
225     void destroyGraphicsLayers();
226     
227     void willDestroyLayer(const GraphicsLayer*);
228
229     LayoutRect compositedBoundsIncludingMargin() const;
230     
231     std::unique_ptr<GraphicsLayer> createGraphicsLayer(const String&);
232
233     RenderLayerModelObject& renderer() const { return m_owningLayer.renderer(); }
234     RenderLayerCompositor& compositor() const { return m_owningLayer.compositor(); }
235
236     void updateInternalHierarchy();
237     bool updateAncestorClippingLayer(bool needsAncestorClip);
238     bool updateDescendantClippingLayer(bool needsDescendantClip);
239     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
240     bool updateForegroundLayer(bool needsForegroundLayer);
241     bool updateBackgroundLayer(bool needsBackgroundLayer);
242     bool updateMaskLayer(bool needsMaskLayer);
243     bool requiresHorizontalScrollbarLayer() const;
244     bool requiresVerticalScrollbarLayer() const;
245     bool requiresScrollCornerLayer() const;
246     bool updateScrollingLayers(bool scrollingLayers);
247     void updateDrawsContent(bool isSimpleContainer);
248     
249     void updateRootLayerConfiguration();
250
251     void setBackgroundLayerPaintsFixedRootBackground(bool);
252
253     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
254     
255     LayoutSize contentOffsetInCompostingLayer() const;
256     // Result is transform origin in device pixels.
257     FloatPoint3D computeTransformOriginForPainting(const LayoutRect& borderBox) const;
258
259     void updateOpacity(const RenderStyle&);
260     void updateTransform(const RenderStyle&);
261 #if ENABLE(CSS_FILTERS)
262     void updateFilters(const RenderStyle&);
263 #endif
264 #if ENABLE(CSS_COMPOSITING)
265     void updateBlendMode(const RenderStyle&);
266 #endif
267     // Return the opacity value that this layer should use for compositing.
268     float compositingOpacity(float rendererOpacity) const;
269     
270     bool isMainFrameRenderViewLayer() const;
271     
272     bool paintsBoxDecorations() const;
273     bool paintsChildren() const;
274
275     // Returns true if this compositing layer has no visible content.
276     bool isSimpleContainerCompositingLayer() const;
277     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
278     bool containsPaintedContent(bool isSimpleContainer) const;
279     // Returns true if the RenderLayer just contains an image that we can composite directly.
280     bool isDirectlyCompositedImage() const;
281     void updateImageContents();
282
283     Color rendererBackgroundColor() const;
284     void updateDirectlyCompositedBackgroundColor(bool isSimpleContainer, bool& didUpdateContentsRect);
285     void updateDirectlyCompositedBackgroundImage(bool isSimpleContainer, bool& didUpdateContentsRect);
286     void updateDirectlyCompositedContents(bool isSimpleContainer, bool& didUpdateContentsRect);
287
288     void resetContentsRect();
289
290     bool isPaintDestinationForDescendentLayers() const;
291
292     bool shouldClipCompositedBounds() const;
293
294     bool hasTiledBackingFlatteningLayer() const { return (m_childContainmentLayer && m_usingTiledCacheLayer); }
295     GraphicsLayer* tileCacheFlatteningLayer() const { return m_usingTiledCacheLayer ? m_childContainmentLayer.get() : 0; }
296
297     void paintIntoLayer(const GraphicsLayer*, GraphicsContext*, const IntRect& paintDirtyRect, PaintBehavior, GraphicsLayerPaintingPhase);
298
299     // Helper function for updateGeometry.
300     void adjustAncestorCompositingBoundsForFlowThread(LayoutRect& ancestorCompositingBounds, const RenderLayer* compositingAncestor) const;
301
302     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
303     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
304
305     RenderLayer& m_owningLayer;
306
307     std::unique_ptr<GraphicsLayer> m_ancestorClippingLayer; // Only used if we are clipped by an ancestor which is not a stacking context.
308     std::unique_ptr<GraphicsLayer> m_contentsContainmentLayer; // Only used if we have a background layer; takes the transform.
309     std::unique_ptr<GraphicsLayer> m_graphicsLayer;
310     std::unique_ptr<GraphicsLayer> m_foregroundLayer; // Only used in cases where we need to draw the foreground separately.
311     std::unique_ptr<GraphicsLayer> m_backgroundLayer; // Only used in cases where we need to draw the background separately.
312     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.
313     std::unique_ptr<GraphicsLayer> m_maskLayer; // Only used if we have a mask.
314
315     std::unique_ptr<GraphicsLayer> m_layerForHorizontalScrollbar;
316     std::unique_ptr<GraphicsLayer> m_layerForVerticalScrollbar;
317     std::unique_ptr<GraphicsLayer> m_layerForScrollCorner;
318
319     std::unique_ptr<GraphicsLayer> m_scrollingLayer; // Only used if the layer is using composited scrolling.
320     std::unique_ptr<GraphicsLayer> m_scrollingContentsLayer; // Only used if the layer is using composited scrolling.
321
322     ScrollingNodeID m_viewportConstrainedNodeID;
323     ScrollingNodeID m_scrollingNodeID;
324
325     LayoutRect m_compositedBounds;
326     LayoutSize m_devicePixelFractionFromRenderer;
327
328     bool m_artificiallyInflatedBounds; // bounds had to be made non-zero to make transform-origin work
329     bool m_isMainFrameRenderViewLayer;
330     bool m_usingTiledCacheLayer;
331     bool m_requiresOwnBackingStore;
332 #if ENABLE(CSS_FILTERS)
333     bool m_canCompositeFilters;
334 #endif
335     bool m_backgroundLayerPaintsFixedRootBackground;
336
337     static bool m_creatingPrimaryGraphicsLayer;
338 };
339
340 enum CanvasCompositingStrategy {
341     UnacceleratedCanvas,
342     CanvasPaintedToLayer,
343     CanvasAsLayerContents
344 };
345 CanvasCompositingStrategy canvasCompositingStrategy(const RenderObject&);
346
347 } // namespace WebCore
348
349 #endif // RenderLayerBacking_h