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