bb3780147b16c26b75a7ccd22aa8b8fe84e76bbd
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCProxy.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 CCProxy_h
26 #define CCProxy_h
27
28 #include "IntRect.h"
29 #include <wtf/Noncopyable.h>
30 #include <wtf/PassOwnPtr.h>
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/Threading.h>
33
34 #if USE(SKIA)
35 class GrContext;
36 #endif
37
38 namespace WebCore {
39
40 class CCThread;
41 class CCLayerTreeHost;
42 class CCLayerTreeHostImpl;
43 class CCLayerTreeHostImplClient;
44 class GraphicsContext3D;
45 struct LayerRendererCapabilities;
46 class TextureManager;
47
48 // Abstract class responsible for proxying commands from the main-thread side of
49 // the compositor over to the compositor implementation.
50 class CCProxy {
51     WTF_MAKE_NONCOPYABLE(CCProxy);
52 public:
53     static void setMainThread(CCThread*);
54     static CCThread* mainThread();
55
56     static bool hasImplThread();
57     static void setImplThread(CCThread*);
58     static CCThread* implThread();
59
60     virtual ~CCProxy();
61
62     virtual bool compositeAndReadback(void *pixels, const IntRect&) = 0;
63
64     virtual void finishAllRendering() = 0;
65
66     virtual bool isStarted() const = 0;
67
68     virtual bool initializeLayerRenderer() = 0;
69
70     virtual int compositorIdentifier() const = 0;
71
72     virtual const LayerRendererCapabilities& layerRendererCapabilities() const = 0;
73
74     virtual void setNeedsAnimate() = 0;
75     virtual void setNeedsCommit() = 0;
76     virtual void setNeedsRedraw() = 0;
77     virtual void setVisible(bool) = 0;
78
79     virtual void start() = 0; // Must be called before using the proxy.
80     virtual void stop() = 0; // Must be called before deleting the proxy.
81
82     // Debug hooks
83 #ifndef NDEBUG
84     static bool isMainThread();
85     static bool isImplThread();
86 #endif
87
88     // Temporary hack while render_widget still does scheduling for CCLayerTreeHostMainThreadI
89     virtual GraphicsContext3D* context() = 0;
90
91     // Testing hooks
92     virtual void loseCompositorContext(int numTimes) = 0;
93
94 #ifndef NDEBUG
95     static void setCurrentThreadIsImplThread(bool);
96 #endif
97
98 protected:
99     CCProxy();
100     friend class DebugScopedSetImplThread;
101 };
102
103 }
104
105 #endif