[chromium] Hook WebCompositor interface for input events up to the compositor proper
[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     int compositorIdentifier() const { return m_compositorIdentifier; }
117
118 #if !USE(THREADED_COMPOSITING)
119     void composite();
120 #endif
121
122     GraphicsContext3D* context();
123
124     // Composites and attempts to read back the result into the provided
125     // buffer. If it wasn't possible, e.g. due to context lost, will return
126     // false.
127     bool compositeAndReadback(void *pixels, const IntRect&);
128
129     void finishAllRendering();
130
131     int frameNumber() const { return m_frameNumber; }
132
133     void setZoomAnimatorTransform(const TransformationMatrix&);
134
135     const LayerRendererCapabilities& layerRendererCapabilities() const;
136
137     // Test-only hook
138     void loseCompositorContext(int numTimes);
139
140     void setNeedsCommitThenRedraw();
141     void setNeedsRedraw();
142
143     LayerChromium* rootLayer() { return m_rootLayer.get(); }
144     const LayerChromium* rootLayer() const { return m_rootLayer.get(); }
145
146     const CCSettings& settings() const { return m_settings; }
147
148     void setViewport(const IntSize& viewportSize);
149
150     const IntSize& viewportSize() const { return m_viewportSize; }
151     TextureManager* contentsTextureManager() const;
152
153     void setVisible(bool);
154
155     void updateLayers();
156
157     void applyScrollDeltas(const CCScrollUpdateSet&);
158 protected:
159     CCLayerTreeHost(CCLayerTreeHostClient*, PassRefPtr<LayerChromium> rootLayer, const CCSettings&);
160     bool initialize();
161
162 private:
163     typedef Vector<RefPtr<LayerChromium> > LayerList;
164
165     void paintLayerContents(const LayerList&);
166     void updateLayers(LayerChromium*);
167     void updateCompositorResources(const LayerList&, GraphicsContext3D*, TextureAllocator*);
168     void updateCompositorResources(LayerChromium*, GraphicsContext3D*, TextureAllocator*);
169     void clearPendingUpdate();
170
171     int m_compositorIdentifier;
172
173     bool m_animating;
174
175     CCLayerTreeHostClient* m_client;
176
177     int m_frameNumber;
178
179     OwnPtr<CCProxy> m_proxy;
180
181     RefPtr<LayerChromium> m_rootLayer;
182     OwnPtr<TextureManager> m_contentsTextureManager;
183
184     LayerList m_updateList;
185
186     CCSettings m_settings;
187
188     IntSize m_viewportSize;
189     TransformationMatrix m_zoomAnimatorTransform;
190     bool m_visible;
191 };
192
193 }
194
195 #endif