Remote Layer Tree: Force repaint
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / mac / RemoteLayerTreeContext.h
1 /*
2  * Copyright (C) 2012 Apple 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''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef RemoteLayerTreeContext_h
27 #define RemoteLayerTreeContext_h
28
29 #include "LayerTreeContext.h"
30 #include "RemoteLayerTreeTransaction.h"
31 #include "WebPage.h"
32 #include <WebCore/GraphicsLayerFactory.h>
33 #include <WebCore/PlatformCALayer.h>
34 #include <WebCore/Timer.h>
35 #include <wtf/Vector.h>
36
37 namespace WebKit {
38
39 class PlatformCALayerRemote;
40 class WebPage;
41
42 class RemoteLayerTreeContext : public WebCore::GraphicsLayerFactory {
43 public:
44     explicit RemoteLayerTreeContext(WebPage*);
45     ~RemoteLayerTreeContext();
46
47     void setRootLayer(WebCore::GraphicsLayer*);
48
49     void scheduleLayerFlush();
50
51     void layerWasCreated(PlatformCALayerRemote*, WebCore::PlatformCALayer::LayerType);
52     void layerWillBeDestroyed(PlatformCALayerRemote*);
53
54     void outOfTreeLayerWasAdded(WebCore::GraphicsLayer*);
55     void outOfTreeLayerWillBeRemoved(WebCore::GraphicsLayer*);
56
57     LayerHostingMode layerHostingMode() const { return m_webPage->layerHostingMode(); }
58
59     void setIsFlushingSuspended(bool);
60
61     void forceRepaint();
62
63 private:
64     // WebCore::GraphicsLayerFactory
65     virtual std::unique_ptr<WebCore::GraphicsLayer> createGraphicsLayer(WebCore::GraphicsLayerClient*) OVERRIDE;
66
67     void layerFlushTimerFired(WebCore::Timer<RemoteLayerTreeContext>*);
68     void flushLayers();
69
70     WebPage* m_webPage;
71     WebCore::Timer<RemoteLayerTreeContext> m_layerFlushTimer;
72
73     RefPtr<PlatformCALayerRemote> m_rootLayer;
74     Vector<WebCore::GraphicsLayer*> m_outOfTreeLayers;
75
76     Vector<RemoteLayerTreeTransaction::LayerCreationProperties> m_createdLayers;
77     Vector<RemoteLayerTreeTransaction::LayerID> m_destroyedLayers;
78
79     bool m_isFlushingSuspended;
80     bool m_hasDeferredFlush;
81 };
82
83 } // namespace WebKit
84
85 #endif // RemoteLayerTreeContext_h