Source/WebCore: parse CSS attribute -webkit-blend-mode
[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 hasMaskLayer() const { return m_maskLayer != 0; }
88
89     GraphicsLayer* parentForSublayers() const { return m_containmentLayer ? m_containmentLayer.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 bool usingTileCache(const GraphicsLayer*) const { return m_usingTiledCacheLayer; }
134     virtual void notifyAnimationStarted(const GraphicsLayer*, double startTime);
135     virtual void notifySyncRequired(const GraphicsLayer*);
136
137     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& clip);
138
139     virtual float deviceScaleFactor() const;
140     virtual float pageScaleFactor() const;
141     virtual void didCommitChangesForLayer(const GraphicsLayer*) const;
142
143     virtual bool showDebugBorders(const GraphicsLayer*) const;
144     virtual bool showRepaintCounter(const GraphicsLayer*) const;
145
146 #ifndef NDEBUG
147     virtual void verifyNotPainting();
148 #endif
149
150     IntRect contentsBox() const;
151     
152     // For informative purposes only.
153     CompositingLayerType compositingLayerType() const;
154     
155     GraphicsLayer* layerForHorizontalScrollbar() const { return m_layerForHorizontalScrollbar.get(); }
156     GraphicsLayer* layerForVerticalScrollbar() const { return m_layerForVerticalScrollbar.get(); }
157     GraphicsLayer* layerForScrollCorner() const { return m_layerForScrollCorner.get(); }
158
159 #if ENABLE(CSS_FILTERS)
160     bool canCompositeFilters() const { return m_canCompositeFilters; }
161 #endif
162
163     // Return an estimate of the backing store area (in pixels) allocated by this object's GraphicsLayers.
164     double backingStoreMemoryEstimate() const;
165
166     String nameForLayer() const;
167     
168 #if ENABLE(CSS_COMPOSITING)
169     void setBlendMode(BlendMode);
170 #endif
171
172 private:
173     void createPrimaryGraphicsLayer();
174     void destroyGraphicsLayers();
175     
176     PassOwnPtr<GraphicsLayer> createGraphicsLayer(const String&);
177
178     RenderBoxModelObject* renderer() const { return m_owningLayer->renderer(); }
179     RenderLayerCompositor* compositor() const { return m_owningLayer->compositor(); }
180
181     void updateInternalHierarchy();
182     bool updateClippingLayers(bool needsAncestorClip, bool needsDescendantClip);
183     bool updateOverflowControlsLayers(bool needsHorizontalScrollbarLayer, bool needsVerticalScrollbarLayer, bool needsScrollCornerLayer);
184     bool updateForegroundLayer(bool needsForegroundLayer);
185     bool updateMaskLayer(bool needsMaskLayer);
186     bool requiresHorizontalScrollbarLayer() const;
187     bool requiresVerticalScrollbarLayer() const;
188     bool requiresScrollCornerLayer() const;
189
190     GraphicsLayerPaintingPhase paintingPhaseForPrimaryLayer() const;
191     
192     IntSize contentOffsetInCompostingLayer() const;
193     // Result is transform origin in pixels.
194     FloatPoint3D computeTransformOrigin(const IntRect& borderBox) const;
195     // Result is perspective origin in pixels.
196     FloatPoint computePerspectiveOrigin(const IntRect& borderBox) const;
197
198     void updateLayerOpacity(const RenderStyle*);
199     void updateLayerTransform(const RenderStyle*);
200 #if ENABLE(CSS_FILTERS)
201     void updateLayerFilters(const RenderStyle*);
202 #endif
203 #if ENABLE(CSS_COMPOSITING)
204     void updateLayerBlendMode(const RenderStyle*);
205 #endif
206     // Return the opacity value that this layer should use for compositing.
207     float compositingOpacity(float rendererOpacity) const;
208     
209     bool isMainFrameRenderViewLayer() const;
210     
211     bool paintsBoxDecorations() const;
212     bool paintsChildren() const;
213
214     // Returns true if this compositing layer has no visible content.
215     bool isSimpleContainerCompositingLayer() const;
216     // Returns true if this layer has content that needs to be rendered by painting into the backing store.
217     bool containsPaintedContent() const;
218     // Returns true if the RenderLayer just contains an image that we can composite directly.
219     bool isDirectlyCompositedImage() const;
220     void updateImageContents();
221
222     Color rendererBackgroundColor() const;
223     void updateBackgroundColor();
224
225     bool containsNonEmptyRenderers() const;
226     bool hasVisibleNonCompositingDescendantLayers() const;
227
228     bool shouldClipCompositedBounds() const;
229
230     bool hasTileCacheFlatteningLayer() const { return (m_containmentLayer && m_usingTiledCacheLayer); }
231     GraphicsLayer* tileCacheFlatteningLayer() const { return m_usingTiledCacheLayer ? m_containmentLayer.get() : 0; }
232
233     void paintIntoLayer(RenderLayer* rootLayer, GraphicsContext*, const IntRect& paintDirtyRect, PaintBehavior, GraphicsLayerPaintingPhase, RenderObject* paintingRoot);
234
235     static CSSPropertyID graphicsLayerToCSSProperty(AnimatedPropertyID);
236     static AnimatedPropertyID cssToGraphicsLayerProperty(CSSPropertyID);
237
238     RenderLayer* m_owningLayer;
239
240     OwnPtr<GraphicsLayer> m_ancestorClippingLayer; // only used if we are clipped by an ancestor which is not a stacking context
241     OwnPtr<GraphicsLayer> m_graphicsLayer;
242     OwnPtr<GraphicsLayer> m_foregroundLayer;       // only used in cases where we need to draw the foreground separately
243     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.
244     OwnPtr<GraphicsLayer> m_maskLayer;             // only used if we have a mask
245
246     OwnPtr<GraphicsLayer> m_layerForHorizontalScrollbar;
247     OwnPtr<GraphicsLayer> m_layerForVerticalScrollbar;
248     OwnPtr<GraphicsLayer> m_layerForScrollCorner;
249
250     IntRect m_compositedBounds;
251
252     bool m_artificiallyInflatedBounds;      // bounds had to be made non-zero to make transform-origin work
253     bool m_isMainFrameRenderViewLayer;
254     bool m_usingTiledCacheLayer;
255     bool m_requiresOwnBackingStore;
256 #if ENABLE(CSS_FILTERS)
257     bool m_canCompositeFilters;
258 #endif
259
260     static bool m_creatingPrimaryGraphicsLayer;
261 };
262
263 } // namespace WebCore
264
265 #endif // USE(ACCELERATED_COMPOSITING)
266
267 #endif // RenderLayerBacking_h