0d5a4a2d8a516b1d7bcf991a99e1c78789943ec5
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCSingleThreadProxy.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 CCSingleThreadProxy_h
26 #define CCSingleThreadProxy_h
27
28 #include "cc/CCCompletionEvent.h"
29 #include "cc/CCLayerTreeHostImpl.h"
30 #include "cc/CCProxy.h"
31 #include <wtf/OwnPtr.h>
32
33 namespace WebCore {
34
35 class CCLayerTreeHost;
36
37 class CCSingleThreadProxy : public CCProxy, CCLayerTreeHostImplClient {
38 public:
39     static PassOwnPtr<CCProxy> create(CCLayerTreeHost*);
40     virtual ~CCSingleThreadProxy();
41
42     // CCProxy implementation
43     virtual bool compositeAndReadback(void *pixels, const IntRect&);
44     virtual GraphicsContext3D* context();
45     virtual void finishAllRendering();
46     virtual bool isStarted() const;
47     virtual bool initializeLayerRenderer();
48     virtual int compositorIdentifier() const { return m_compositorIdentifier; }
49     virtual const LayerRendererCapabilities& layerRendererCapabilities() const;
50     virtual void loseCompositorContext(int numTimes);
51     virtual void setNeedsAnimate();
52     virtual void setNeedsCommit();
53     virtual void setNeedsRedraw();
54     virtual void setVisible(bool);
55     virtual void start();
56     virtual void stop();
57
58     // CCLayerTreeHostImplClient implementation
59     virtual void onSwapBuffersCompleteOnImplThread() { ASSERT_NOT_REACHED(); }
60     virtual void setNeedsRedrawOnImplThread() { m_layerTreeHost->setNeedsCommit(); }
61     virtual void setNeedsCommitOnImplThread() { m_layerTreeHost->setNeedsCommit(); }
62
63     // Called by the legacy path where RenderWidget does the scheduling.
64     void compositeImmediately();
65
66 private:
67     explicit CCSingleThreadProxy(CCLayerTreeHost*);
68     bool recreateContextIfNeeded();
69     void commitIfNeeded();
70     void doCommit();
71     bool doComposite();
72
73     // Accessed on main thread only.
74     CCLayerTreeHost* m_layerTreeHost;
75     int m_compositorIdentifier;
76
77     // Used on the CCThread, but checked on main thread during initialization/shutdown.
78     OwnPtr<CCLayerTreeHostImpl> m_layerTreeHostImpl;
79     LayerRendererCapabilities m_layerRendererCapabilitiesForMainThread;
80
81     int m_numFailedRecreateAttempts;
82     bool m_graphicsContextLost;
83     int m_timesRecreateShouldFail; // Used during testing.
84     bool m_nextFrameIsNewlyCommittedFrame;
85 };
86
87 // For use in the single-threaded case. In debug builds, it pretends that the
88 // code is running on the thread to satisfy assertion checks.
89 class DebugScopedSetImplThread {
90 public:
91     DebugScopedSetImplThread()
92     {
93 #if !ASSERT_DISABLED
94         CCProxy::setCurrentThreadIsImplThread(true);
95 #endif
96     }
97     ~DebugScopedSetImplThread()
98     {
99 #if !ASSERT_DISABLED
100         CCProxy::setCurrentThreadIsImplThread(false);
101 #endif
102     }
103 };
104
105 } // namespace WebCore
106
107 #endif