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