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