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