Change RenderLayerBacking::nameForLayer() to RenderLayer::name()
[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 #include "TransformationMatrix.h"
37
38 namespace WebCore {
39
40 class KeyframeList;
41 class RenderLayerCompositor;
42 class TiledBacking;
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     RenderLayerBacking(RenderLayer*);
61     ~RenderLayerBacking();
62
63     RenderLayer* owningLayer() const { return m_owningLayer; }
64
65     enum UpdateAfterLayoutFlag {
66         CompositingChildrenOnly = 1 << 0,
67         NeedsFullRepaint = 1 << 1,
68         IsUpdateRoot = 1 << 2
69     };
70     typedef unsigned UpdateAfterLayoutFlags;
71     void updateAfterLayout(UpdateAfterLayoutFlags);
72     
73     // Returns true if layer configuration changed.
74     bool updateGraphicsLayerConfiguration();
75     // Update graphics layer position and bounds.
76     void updateGraphicsLayerGeometry(); // make private
77     // Update contents and clipping structure.
78     void updateDrawsContent();
79     
80     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
81
82     // Layer to clip children
83     bool hasClippingLayer() const { return (m_containmentLayer && !m_usingTiledCacheLayer); }
84     GraphicsLayer* clippingLayer() const { return !m_usingTiledCacheLayer ? m_containmentLayer.get() : 0; }
85
86     // Layer to get clipped by ancestor
87     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != 0; }
88     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
89
90     bool hasContentsLayer() const { return m_foregroundLayer != 0; }
91     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
92
93     bool hasScrollingLayer() const { return m_scrollingLayer; }
94     GraphicsLayer* scrollingLayer() const { return m_scrollingLayer.get(); }
95     GraphicsLayer* scrollingContentsLayer() const { return m_scrollingContentsLayer.get(); }
96
97     void attachToScrollingCoordinatorWithParent(RenderLayerBacking* parent);
98     void detachFromScrollingCoordinator();
99     uint64_t scrollLayerID() const { return m_scrollLayerID; }
100     
101     bool hasMaskLayer() const { return m_maskLayer != 0; }
102
103     GraphicsLayer* parentForSublayers() const;
104     GraphicsLayer* childForSuperlayers() const { return m_ancestorClippingLayer ? m_ancestorClippingLayer.get() : m_graphicsLayer.get(); }
105
106     // RenderLayers with backing normally short-circuit paintLayer() because
107     // their content is rendered via callbacks from GraphicsLayer. However, the document
108     // layer is special, because it has a GraphicsLayer to act as a container for the GraphicsLayers
109     // for descendants, but its contents usually render into the window (in which case this returns true).
110     // This returns false for other layers, and when the document layer actually needs to paint into its backing store
111     // for some reason.
112     bool paintsIntoWindow() const;
113     
114     // Returns true for a composited layer that has no backing store of its own, so
115     // paints into some ancestor layer.
116     bool paintsIntoCompositedAncestor() const { return !m_requiresOwnBackingStore; }
117
118     void setRequiresOwnBackingStore(bool);
119
120     void setContentsNeedDisplay();
121     // r is in the coordinate space of the layer's render object
122     void setContentsNeedDisplayInRect(const IntRect&);
123
124     // Notification from the renderer that its content changed.
125     void contentChanged(ContentChangeType);
126
127     // Interface to start, finish, suspend and resume animations and transitions
128     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
129     void transitionPaused(double timeOffset, CSSPropertyID);
130     void transitionFinished(CSSPropertyID);
131
132     bool startAnimation(double timeOffset, const Animation* anim, const KeyframeList& keyframes);
133     void animationPaused(double timeOffset, const String& name);
134     void animationFinished(const String& name);
135
136     void suspendAnimations(double time = 0);
137     void resumeAnimations();
138
139     IntRect compositedBounds() const;
140     void setCompositedBounds(const IntRect&);
141     void updateCompositedBounds();
142     
143     void updateAfterWidgetResize();
144     void positionOverflowControlsLayers(const IntSize& offsetFromRoot);
145     bool hasUnpositionedOverflowControlsLayers() const;
146
147     bool usingTileCache() const { return m_usingTiledCacheLayer; }
148     TiledBacking* tiledBacking() const;
149     void adjustTileCacheCoverage();
150     
151     void updateDebugIndicators(bool showBorder, bool showRepaintCounter);
152     
153     // GraphicsLayerClient interface
154     virtual bool shouldUseTileCache(const GraphicsLayer*) const OVERRIDE;
155     virtual void notifyAnimationStarted(const GraphicsLayer*, double startTime) OVERRIDE;
156     virtual void notifyFlushRequired(const GraphicsLayer*) OVERRIDE;
157     virtual void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) OVERRIDE;
158
159     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& clip) OVERRIDE;
160
161     virtual float deviceScaleFactor() const OVERRIDE;
162     virtual float pageScaleFactor() const OVERRIDE;
163     virtual void didCommitChangesForLayer(const GraphicsLayer*) const OVERRIDE;
164     virtual bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const OVERRIDE;
165
166     virtual bool isTrackingRepaints() const OVERRIDE;
167
168 #ifndef NDEBUG
169     virtual void verifyNotPainting();
170 #endif
171
172     IntRect contentsBox() const;
173     IntRect backgroundBox() const;
174     
175     // For informative purposes only.
176     CompositingLayerType compositingLayerType() const;
177     
178     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
179     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
180     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
181
182 #if ENABLE(CSS_FILTERS)
183     bool canCompositeFilters() const { return m_canCompositeFilters; }
184 #endif
185
186     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
187     double backingStoreMemoryEstimate() const;
188
189 #if ENABLE(CSS_COMPOSITING)
190     void setBlendMode(BlendMode);
191 #endif
192     void reportMemoryUsage(MemoryObjectInfo*) const;
193
194 private:
195     void createPrimaryGraphicsLayer();
196     void destroyGraphicsLayers();
197     
198     PassOwnPtr<GraphicsLayer> createGraphicsLayer(const String&);
199
200     RenderLayerModelObject* renderer() const { return m_owningLayer->renderer(); }
201     RenderLayerCompositor* compositor() const { return m_owningLayer->compositor(); }
202
203     void updateInternalHierarchy();
204     bool updateClippingLayers(bool needsAncestorClip, bool needsDescendantClip);
205     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
206     bool updateForegroundLayer(bool needsForegroundLayer);
207     bool updateMaskLayer(bool needsMaskLayer);
208     bool requiresHorizontalScrollbarLayer() const;
209     bool requiresVerticalScrollbarLayer() const;
210     bool requiresScrollCornerLayer() const;
211     bool updateScrollingLayers(bool scrollingLayers);
212     void updateDrawsContent(bool isSimpleContainer);
213
214     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
215     
216     IntSize contentOffsetInCompostingLayer() const;
217     // Result is transform origin in pixels.
218     FloatPoint3D computeTransformOrigin(const IntRect& borderBox) const;
219     // Result is perspective origin in pixels.
220     FloatPoint computePerspectiveOrigin(const IntRect& borderBox) const;
221
222     void updateOpacity(const RenderStyle*);
223     void updateTransform(const RenderStyle*);
224 #if ENABLE(CSS_FILTERS)
225     void updateFilters(const RenderStyle*);
226 #endif
227 #if ENABLE(CSS_COMPOSITING)
228     void updateLayerBlendMode(const RenderStyle*);
229 #endif
230     // Return the opacity value that this layer should use for compositing.
231     float compositingOpacity(float rendererOpacity) const;
232     
233     bool isMainFrameRenderViewLayer() const;
234     
235     bool paintsBoxDecorations() const;
236     bool paintsChildren() const;
237
238     // Returns true if this compositing layer has no visible content.
239     bool isSimpleContainerCompositingLayer() const;
240     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
241     bool containsPaintedContent() const;
242     // Returns true if the RenderLayer just contains an image that we can composite directly.
243     bool isDirectlyCompositedImage() const;
244     void updateImageContents();
245
246     Color rendererBackgroundColor() const;
247     void updateBackgroundColor(bool isSimpleContainer);
248     void updateContentsRect(bool isSimpleContainer);
249
250     bool containsNonEmptyRenderers() const;
251     bool hasVisibleNonCompositingDescendantLayers() const;
252
253     bool shouldClipCompositedBounds() const;
254
255     bool hasTileCacheFlatteningLayer() const { return (m_containmentLayer && m_usingTiledCacheLayer); }
256     GraphicsLayer* tileCacheFlatteningLayer() const { return m_usingTiledCacheLayer ? m_containmentLayer.get() : 0; }
257
258     void paintIntoLayer(RenderLayer* rootLayer, GraphicsContext*, const IntRect& paintDirtyRect, PaintBehavior, GraphicsLayerPaintingPhase);
259
260     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
261     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
262
263     RenderLayer* m_owningLayer;
264
265     OwnPtr<GraphicsLayer> m_ancestorClippingLayer; // only used if we are clipped by an ancestor which is not a stacking context
266     OwnPtr<GraphicsLayer> m_graphicsLayer;
267     OwnPtr<GraphicsLayer> m_foregroundLayer;       // only used in cases where we need to draw the foreground separately
268     OwnPtr<GraphicsLayer> m_containmentLayer; // Only used if we have clipping on a stacking context with compositing children, or if the layer has a tile cache.
269     OwnPtr<GraphicsLayer> m_maskLayer;             // only used if we have a mask
270
271     OwnPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
272     OwnPtr<GraphicsLayer> m_layerForVerticalScrollbar;
273     OwnPtr<GraphicsLayer> m_layerForScrollCorner;
274
275     OwnPtr<GraphicsLayer> m_scrollingLayer; // only used if the layer is using composited scrolling.
276     OwnPtr<GraphicsLayer> m_scrollingContentsLayer; // only used if the layer is using composited scrolling.
277
278     uint64_t m_scrollLayerID;
279
280     IntRect m_compositedBounds;
281
282     bool m_artificiallyInflatedBounds; // bounds had to be made non-zero to make transform-origin work
283     bool m_boundsConstrainedByClipping;
284     bool m_isMainFrameRenderViewLayer;
285     bool m_usingTiledCacheLayer;
286     bool m_requiresOwnBackingStore;
287 #if ENABLE(CSS_FILTERS)
288     bool m_canCompositeFilters;
289 #endif
290
291     static bool m_creatingPrimaryGraphicsLayer;
292 };
293
294 } // namespace WebCore
295
296 #endif // USE(ACCELERATED_COMPOSITING)
297
298 #endif // RenderLayerBacking_h