2f989bcf6a191c10fc741c9af1de7ca91c30605e
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCLayerTreeHost.h
1 /*
2  * Copyright (C) 2011 Google 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. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef CCLayerTreeHost_h
26 #define CCLayerTreeHost_h
27
28 #include "GraphicsTypes3D.h"
29 #include "IntRect.h"
30 #include "LayerChromium.h"
31 #include "RateLimiter.h"
32 #include "TransformationMatrix.h"
33 #include "cc/CCLayerTreeHostCommon.h"
34 #include "cc/CCProxy.h"
35
36 #include <wtf/HashMap.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefCounted.h>
40
41 #if USE(SKIA)
42 class GrContext;
43 #endif
44
45 namespace WebCore {
46
47 class CCLayerTreeHostImpl;
48 class CCTextureUpdater;
49 class GraphicsContext3D;
50 class LayerPainterChromium;
51 class TextureAllocator;
52 class TextureManager;
53
54 class CCLayerTreeHostClient {
55 public:
56     virtual void updateAnimations(double frameBeginTime) = 0;
57     virtual void layout() = 0;
58     virtual void applyScrollAndScale(const IntSize& scrollDelta, float pageScale) = 0;
59     virtual PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D() = 0;
60     virtual void didRecreateGraphicsContext(bool success) = 0;
61     virtual void didCommitAndDrawFrame() = 0;
62     virtual void didCompleteSwapBuffers() = 0;
63
64     // Used only in the single-threaded path.
65     virtual void scheduleComposite() = 0;
66
67 protected:
68     virtual ~CCLayerTreeHostClient() { }
69 };
70
71 struct CCSettings {
72     CCSettings()
73             : acceleratePainting(false)
74             , compositeOffscreen(false)
75             , showFPSCounter(false)
76             , showPlatformLayerTree(false)
77             , refreshRate(0)
78             , perTilePainting(false)
79             , partialSwapEnabled(false) { }
80
81     bool acceleratePainting;
82     bool compositeOffscreen;
83     bool showFPSCounter;
84     bool showPlatformLayerTree;
85     double refreshRate;
86     bool perTilePainting;
87     bool partialSwapEnabled;
88 };
89
90 // Provides information on an Impl's rendering capabilities back to the CCLayerTreeHost
91 struct LayerRendererCapabilities {
92     LayerRendererCapabilities()
93         : bestTextureFormat(0)
94         , contextHasCachedFrontBuffer(false)
95         , usingPartialSwap(false)
96         , usingMapSub(false)
97         , usingAcceleratedPainting(false)
98         , usingSetVisibility(false)
99         , usingSwapCompleteCallback(false)
100         , usingTextureUsageHint(false)
101         , usingTextureStorageExtension(false)
102         , maxTextureSize(0) { }
103
104     GC3Denum bestTextureFormat;
105     bool contextHasCachedFrontBuffer;
106     bool usingPartialSwap;
107     bool usingMapSub;
108     bool usingAcceleratedPainting;
109     bool usingSetVisibility;
110     bool usingSwapCompleteCallback;
111     bool usingTextureUsageHint;
112     bool usingTextureStorageExtension;
113     int maxTextureSize;
114 };
115
116 class CCLayerTreeHost : public RefCounted<CCLayerTreeHost> {
117 public:
118     static PassRefPtr<CCLayerTreeHost> create(CCLayerTreeHostClient*, const CCSettings&);
119     virtual ~CCLayerTreeHost();
120
121     // Returns true if any CCLayerTreeHost is alive.
122     static bool anyLayerTreeHostInstanceExists();
123
124     // CCLayerTreeHost interface to CCProxy.
125     void updateAnimations(double frameBeginTime);
126     void layout();
127     void beginCommitOnImplThread(CCLayerTreeHostImpl*);
128     void finishCommitOnImplThread(CCLayerTreeHostImpl*);
129     void commitComplete();
130     PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D();
131     virtual PassOwnPtr<CCLayerTreeHostImpl> createLayerTreeHostImpl(CCLayerTreeHostImplClient*);
132     void didBecomeInvisibleOnImplThread(CCLayerTreeHostImpl*);
133     void didRecreateGraphicsContext(bool success);
134     void didCommitAndDrawFrame() { m_client->didCommitAndDrawFrame(); }
135     void didCompleteSwapBuffers() { m_client->didCompleteSwapBuffers(); }
136     void deleteContentsTexturesOnImplThread(TextureAllocator*);
137
138     CCLayerTreeHostClient* client() { return m_client; }
139
140     int compositorIdentifier() const { return m_compositorIdentifier; }
141
142     // Only used when compositing on the main thread.
143     void composite();
144
145     GraphicsContext3D* context();
146
147     // Composites and attempts to read back the result into the provided
148     // buffer. If it wasn't possible, e.g. due to context lost, will return
149     // false.
150     bool compositeAndReadback(void *pixels, const IntRect&);
151
152     void finishAllRendering();
153
154     int frameNumber() const { return m_frameNumber; }
155
156     const LayerRendererCapabilities& layerRendererCapabilities() const;
157
158     // Test-only hook
159     void loseCompositorContext(int numTimes);
160
161     void setNeedsAnimate();
162     // virtual for testing
163     virtual void setNeedsCommit();
164     void setNeedsRedraw();
165
166     LayerChromium* rootLayer() { return m_rootLayer.get(); }
167     const LayerChromium* rootLayer() const { return m_rootLayer.get(); }
168     void setRootLayer(PassRefPtr<LayerChromium>);
169
170     const CCSettings& settings() const { return m_settings; }
171
172     void setViewportSize(const IntSize&);
173
174     const IntSize& viewportSize() const { return m_viewportSize; }
175
176     void setPageScale(float);
177     float pageScale() const { return m_pageScale; }
178
179     void setPageScaleFactorLimits(float minScale, float maxScale);
180
181     TextureManager* contentsTextureManager() const;
182
183     bool visible() const { return m_visible; }
184     void setVisible(bool);
185
186     void setHaveWheelEventHandlers(bool);
187
188     void updateLayers();
189
190     void updateCompositorResources(GraphicsContext3D*, CCTextureUpdater&);
191     void applyScrollAndScale(const CCScrollAndScaleSet&);
192     void startRateLimiter(GraphicsContext3D*);
193     void stopRateLimiter(GraphicsContext3D*);
194
195 protected:
196     CCLayerTreeHost(CCLayerTreeHostClient*, const CCSettings&);
197     bool initialize();
198
199 private:
200     typedef Vector<RefPtr<LayerChromium> > LayerList;
201
202     enum PaintType { PaintVisible, PaintIdle };
203     static void paintContentsIfDirty(LayerChromium*, PaintType);
204     void paintLayerContents(const LayerList&, PaintType);
205     void paintMaskAndReplicaForRenderSurface(LayerChromium*, PaintType);
206
207     void updateLayers(LayerChromium*);
208     void clearPendingUpdate();
209
210     int m_compositorIdentifier;
211
212     bool m_animating;
213
214     CCLayerTreeHostClient* m_client;
215
216     int m_frameNumber;
217
218     OwnPtr<CCProxy> m_proxy;
219
220     RefPtr<LayerChromium> m_rootLayer;
221     OwnPtr<TextureManager> m_contentsTextureManager;
222
223     LayerList m_updateList;
224
225     CCSettings m_settings;
226
227     IntSize m_viewportSize;
228     bool m_visible;
229     bool m_haveWheelEventHandlers;
230     typedef HashMap<GraphicsContext3D*, RefPtr<RateLimiter> > RateLimiterMap;
231     RateLimiterMap m_rateLimiters;
232
233     float m_pageScale;
234     float m_minPageScale, m_maxPageScale;
235     bool m_triggerIdlePaints;
236 };
237
238 }
239
240 #endif