[chromium] Extract scheduling logic from CCThreadProxy to its own class
[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 "TransformationMatrix.h"
31 #include "cc/CCLayerTreeHostCommon.h"
32 #include "cc/CCProxy.h"
33
34 #include <wtf/PassOwnPtr.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37
38 #if USE(SKIA)
39 class GrContext;
40 #endif
41
42 namespace WebCore {
43
44 class CCLayerTreeHostImpl;
45 class GraphicsContext3D;
46 class LayerChromium;
47 class LayerPainterChromium;
48 class TextureAllocator;
49 class TextureManager;
50
51 class CCLayerTreeHostClient {
52 public:
53     virtual void animateAndLayout(double frameBeginTime) = 0;
54     virtual void applyScrollDelta(const IntSize&) = 0;
55     virtual PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D() = 0;
56     virtual void didRecreateGraphicsContext(bool success) = 0;
57 #if !USE(THREADED_COMPOSITING)
58     virtual void scheduleComposite() = 0;
59 #endif
60 protected:
61     virtual ~CCLayerTreeHostClient() { }
62 };
63
64 struct CCSettings {
65     CCSettings()
66             : acceleratePainting(false)
67             , compositeOffscreen(false)
68             , enableCompositorThread(false)
69             , showFPSCounter(false)
70             , showPlatformLayerTree(false) { }
71
72     bool acceleratePainting;
73     bool compositeOffscreen;
74     bool enableCompositorThread;
75     bool showFPSCounter;
76     bool showPlatformLayerTree;
77 };
78
79 // Provides information on an Impl's rendering capabilities back to the CCLayerTreeHost
80 struct LayerRendererCapabilities {
81     LayerRendererCapabilities()
82         : bestTextureFormat(0)
83         , usingMapSub(false)
84         , usingAcceleratedPainting(false)
85         , maxTextureSize(0) { }
86
87     GC3Denum bestTextureFormat;
88     bool usingMapSub;
89     bool usingAcceleratedPainting;
90     int maxTextureSize;
91 };
92
93 class CCLayerTreeHost : public RefCounted<CCLayerTreeHost> {
94 public:
95     static PassRefPtr<CCLayerTreeHost> create(CCLayerTreeHostClient*, PassRefPtr<LayerChromium> rootLayer, const CCSettings&);
96     virtual ~CCLayerTreeHost();
97
98     // CCLayerTreeHost interface to CCProxy.
99     void animateAndLayout(double frameBeginTime);
100     void commitComplete();
101     void commitToOnCCThread(CCLayerTreeHostImpl*);
102     PassRefPtr<GraphicsContext3D> createLayerTreeHostContext3D();
103     virtual PassOwnPtr<CCLayerTreeHostImpl> createLayerTreeHostImpl();
104     void didRecreateGraphicsContext(bool success);
105 #if !USE(THREADED_COMPOSITING)
106     void scheduleComposite();
107 #endif
108     void deleteContentsTexturesOnCCThread(TextureAllocator*);
109
110     // CCLayerTreeHost interface to WebView.
111     bool animating() const { return m_animating; }
112     void setAnimating(bool animating) { m_animating = animating; } // Can be removed when non-threaded scheduling moves inside.
113
114     CCLayerTreeHostClient* client() { return m_client; }
115
116 #if !USE(THREADED_COMPOSITING)
117     void composite();
118 #endif
119
120     GraphicsContext3D* context();
121
122     // Composites and attempts to read back the result into the provided
123     // buffer. If it wasn't possible, e.g. due to context lost, will return
124     // false.
125     bool compositeAndReadback(void *pixels, const IntRect&);
126
127     void finishAllRendering();
128
129     int frameNumber() const { return m_frameNumber; }
130
131     void setZoomAnimatorTransform(const TransformationMatrix&);
132
133     const LayerRendererCapabilities& layerRendererCapabilities() const;
134
135     // Test-only hook
136     void loseCompositorContext(int numTimes);
137
138     void setNeedsCommitThenRedraw();
139     void setNeedsRedraw();
140
141     LayerChromium* rootLayer() { return m_rootLayer.get(); }
142     const LayerChromium* rootLayer() const { return m_rootLayer.get(); }
143
144     const CCSettings& settings() const { return m_settings; }
145
146     void setViewport(const IntSize& viewportSize);
147
148     const IntSize& viewportSize() const { return m_viewportSize; }
149     TextureManager* contentsTextureManager() const;
150
151     void setVisible(bool);
152
153     void updateLayers();
154
155     void applyScrollDeltas(const CCScrollUpdateSet&);
156 protected:
157     CCLayerTreeHost(CCLayerTreeHostClient*, PassRefPtr<LayerChromium> rootLayer, const CCSettings&);
158     bool initialize();
159
160 private:
161     typedef Vector<RefPtr<LayerChromium> > LayerList;
162
163     void paintLayerContents(const LayerList&);
164     void updateLayers(LayerChromium*);
165     void updateCompositorResources(const LayerList&, GraphicsContext3D*, TextureAllocator*);
166     void updateCompositorResources(LayerChromium*, GraphicsContext3D*, TextureAllocator*);
167     void clearPendingUpdate();
168
169     bool m_animating;
170
171     CCLayerTreeHostClient* m_client;
172
173     int m_frameNumber;
174
175     OwnPtr<CCProxy> m_proxy;
176
177     RefPtr<LayerChromium> m_rootLayer;
178     OwnPtr<TextureManager> m_contentsTextureManager;
179
180     LayerList m_updateList;
181
182     CCSettings m_settings;
183
184     IntSize m_viewportSize;
185     TransformationMatrix m_zoomAnimatorTransform;
186     bool m_visible;
187 };
188
189 }
190
191 #endif