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