Improve compositing logging output
[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
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     RenderLayerBacking(RenderLayer*);
60     ~RenderLayerBacking();
61
62     RenderLayer* owningLayer() const { return m_owningLayer; }
63
64     enum UpdateDepth { CompositingChildren, AllDescendants };
65     void updateAfterLayout(UpdateDepth, bool isUpdateRoot);
66     
67     // Returns true if layer configuration changed.
68     bool updateGraphicsLayerConfiguration();
69     // Update graphics layer position and bounds.
70     void updateGraphicsLayerGeometry(); // make private
71     // Update contents and clipping structure.
72     void updateDrawsContent();
73     
74     GraphicsLayer* graphicsLayer() const { return m_graphicsLayer.get(); }
75
76     // Layer to clip children
77     bool hasClippingLayer() const { return m_clippingLayer != 0; }
78     GraphicsLayer* clippingLayer() const { return m_clippingLayer.get(); }
79
80     // Layer to get clipped by ancestor
81     bool hasAncestorClippingLayer() const { return m_ancestorClippingLayer != 0; }
82     GraphicsLayer* ancestorClippingLayer() const { return m_ancestorClippingLayer.get(); }
83
84     bool hasContentsLayer() const { return m_foregroundLayer != 0; }
85     GraphicsLayer* foregroundLayer() const { return m_foregroundLayer.get(); }
86     
87     bool hasMaskLayer() const { return m_maskLayer != 0; }
88
89     GraphicsLayer* parentForSublayers() const { return m_clippingLayer ? m_clippingLayer.get() : m_graphicsLayer.get(); }
90     GraphicsLayer* childForSuperlayers() const { return m_ancestorClippingLayer ? m_ancestorClippingLayer.get() : m_graphicsLayer.get(); }
91
92     // RenderLayers with backing normally short-circuit paintLayer() because
93     // their content is rendered via callbacks from GraphicsLayer. However, the document
94     // layer is special, because it has a GraphicsLayer to act as a container for the GraphicsLayers
95     // for descendants, but its contents usually render into the window (in which case this returns true).
96     // This returns false for other layers, and when the document layer actually needs to paint into its backing store
97     // for some reason.
98     bool paintsIntoWindow() const;
99     
100     // Returns true for a composited layer that has no backing store of its own, so
101     // paints into some ancestor layer.
102     bool paintsIntoCompositedAncestor() const { return !m_requiresOwnBackingStore; }
103
104     void setRequiresOwnBackingStore(bool);
105
106     void setContentsNeedDisplay();
107     // r is in the coordinate space of the layer's render object
108     void setContentsNeedDisplayInRect(const IntRect&);
109
110     // Notification from the renderer that its content changed.
111     void contentChanged(ContentChangeType);
112
113     // Interface to start, finish, suspend and resume animations and transitions
114     bool startTransition(double, CSSPropertyID, const RenderStyle* fromStyle, const RenderStyle* toStyle);
115     void transitionPaused(double timeOffset, CSSPropertyID);
116     void transitionFinished(CSSPropertyID);
117
118     bool startAnimation(double timeOffset, const Animation* anim, const KeyframeList& keyframes);
119     void animationPaused(double timeOffset, const String& name);
120     void animationFinished(const String& name);
121
122     void suspendAnimations(double time = 0);
123     void resumeAnimations();
124
125     IntRect compositedBounds() const;
126     void setCompositedBounds(const IntRect&);
127     void updateCompositedBounds();
128     
129     void updateAfterWidgetResize();
130
131     // GraphicsLayerClient interface
132     virtual bool shouldUseTileCache(const GraphicsLayer*) const;
133     virtual void notifyAnimationStarted(const GraphicsLayer*, double startTime);
134     virtual void notifySyncRequired(const GraphicsLayer*);
135
136     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& clip);
137
138     virtual float deviceScaleFactor() const;
139     virtual float pageScaleFactor() const;
140     virtual void didCommitChangesForLayer(const GraphicsLayer*) const;
141
142     virtual bool showDebugBorders(const GraphicsLayer*) const;
143     virtual bool showRepaintCounter(const GraphicsLayer*) const;
144
145 #ifndef NDEBUG
146     virtual void verifyNotPainting();
147 #endif
148
149     IntRect contentsBox() const;
150     
151     // For informative purposes only.
152     CompositingLayerType compositingLayerType() const;
153     
154     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
155     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
156     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
157
158 #if ENABLE(CSS_FILTERS)
159     bool canCompositeFilters() const { return m_canCompositeFilters; }
160 #endif
161
162     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
163     double backingStoreMemoryEstimate() const;
164
165     String nameForLayer() const;
166     
167 private:
168     void createPrimaryGraphicsLayer();
169     void destroyGraphicsLayers();
170     
171     PassOwnPtr<GraphicsLayer> createGraphicsLayer(const String&);
172
173     RenderBoxModelObject* renderer() const { return m_owningLayer->renderer(); }
174     RenderLayerCompositor* compositor() const { return m_owningLayer->compositor(); }
175
176     void updateInternalHierarchy();
177     bool updateClippingLayers(bool needsAncestorClip, bool needsDescendantClip);
178     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
179     bool updateForegroundLayer(bool needsForegroundLayer);
180     bool updateMaskLayer(bool needsMaskLayer);
181     bool requiresHorizontalScrollbarLayer() const;
182     bool requiresVerticalScrollbarLayer() const;
183     bool requiresScrollCornerLayer() const;
184
185     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
186     
187     IntSize contentOffsetInCompostingLayer() const;
188     // Result is transform origin in pixels.
189     FloatPoint3D computeTransformOrigin(const IntRect& borderBox) const;
190     // Result is perspective origin in pixels.
191     FloatPoint computePerspectiveOrigin(const IntRect& borderBox) const;
192
193     void updateLayerOpacity(const RenderStyle*);
194     void updateLayerTransform(const RenderStyle*);
195 #if ENABLE(CSS_FILTERS)
196     void updateLayerFilters(const RenderStyle*);
197 #endif
198
199     // Return the opacity value that this layer should use for compositing.
200     float compositingOpacity(float rendererOpacity) const;
201     
202     bool isMainFrameRenderViewLayer() const;
203     
204     bool paintsBoxDecorations() const;
205     bool paintsChildren() const;
206
207     // Returns true if this compositing layer has no visible content.
208     bool isSimpleContainerCompositingLayer() const;
209     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
210     bool containsPaintedContent() const;
211     // Returns true if the RenderLayer just contains an image that we can composite directly.
212     bool isDirectlyCompositedImage() const;
213     void updateImageContents();
214
215     Color rendererBackgroundColor() const;
216     void updateBackgroundColor();
217
218     bool containsNonEmptyRenderers() const;
219     bool hasVisibleNonCompositingDescendantLayers() const;
220
221     bool shouldClipCompositedBounds() const;
222
223     void paintIntoLayer(RenderLayer* rootLayer, GraphicsContext*, const IntRect& paintDirtyRect, PaintBehavior, GraphicsLayerPaintingPhase, RenderObject* paintingRoot);
224
225     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
226     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
227
228     RenderLayer* m_owningLayer;
229
230     OwnPtr<GraphicsLayer> m_ancestorClippingLayer; // only used if we are clipped by an ancestor which is not a stacking context
231     OwnPtr<GraphicsLayer> m_graphicsLayer;
232     OwnPtr<GraphicsLayer> m_foregroundLayer;       // only used in cases where we need to draw the foreground separately
233     OwnPtr<GraphicsLayer> m_clippingLayer;         // only used if we have clipping on a stacking context, with compositing children
234     OwnPtr<GraphicsLayer> m_maskLayer;             // only used if we have a mask
235
236     OwnPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
237     OwnPtr<GraphicsLayer> m_layerForVerticalScrollbar;
238     OwnPtr<GraphicsLayer> m_layerForScrollCorner;
239
240     IntRect m_compositedBounds;
241
242     bool m_artificiallyInflatedBounds;      // bounds had to be made non-zero to make transform-origin work
243     bool m_isMainFrameRenderViewLayer;
244     bool m_usingTiledCacheLayer;
245     bool m_requiresOwnBackingStore;
246 #if ENABLE(CSS_FILTERS)
247     bool m_canCompositeFilters;
248 #endif
249 };
250
251 } // namespace WebCore
252
253 #endif // USE(ACCELERATED_COMPOSITING)
254
255 #endif // RenderLayerBacking_h