[Coordinated Graphics] WebPage shouldn't use the layerTreeHost directly
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / LayerTreeHost.h
1 /*
2  * Copyright (C) 2011, 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 LayerTreeHost_h
27 #define LayerTreeHost_h
28
29 #if USE(COORDINATED_GRAPHICS) || USE(TEXTURE_MAPPER)
30
31 #include "LayerTreeContext.h"
32 #include <wtf/Forward.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35
36 namespace IPC {
37 class Connection;
38 }
39
40 namespace WebCore {
41 class IntRect;
42 class IntSize;
43 class GraphicsLayer;
44 class GraphicsLayerFactory;
45 #if USE(COORDINATED_GRAPHICS_THREADED)
46 struct ViewportAttributes;
47 #endif
48 }
49
50 namespace WebKit {
51
52 class WebPage;
53
54 class LayerTreeHost : public RefCounted<LayerTreeHost> {
55 public:
56     static RefPtr<LayerTreeHost> create(WebPage&);
57     virtual ~LayerTreeHost();
58
59     const LayerTreeContext& layerTreeContext() const { return m_layerTreeContext; }
60     void setLayerFlushSchedulingEnabled(bool);
61     void setShouldNotifyAfterNextScheduledLayerFlush(bool notifyAfterScheduledLayerFlush) { m_notifyAfterScheduledLayerFlush = notifyAfterScheduledLayerFlush; }
62
63     virtual void scheduleLayerFlush() = 0;
64     virtual void cancelPendingLayerFlush() = 0;
65     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*) = 0;
66     virtual void invalidate();
67
68     virtual void setNonCompositedContentsNeedDisplay() { };
69     virtual void setNonCompositedContentsNeedDisplayInRect(const WebCore::IntRect&) { };
70     virtual void scrollNonCompositedContents(const WebCore::IntRect&) { };
71     virtual void forceRepaint() = 0;
72     virtual bool forceRepaintAsync(uint64_t /*callbackID*/) { return false; }
73     virtual void sizeDidChange(const WebCore::IntSize& newSize) = 0;
74     virtual void pageBackgroundTransparencyChanged() = 0;
75
76     virtual void pauseRendering();
77     virtual void resumeRendering();
78
79     virtual WebCore::GraphicsLayerFactory* graphicsLayerFactory() { return nullptr; }
80
81 #if USE(COORDINATED_GRAPHICS_MULTIPROCESS)
82     virtual void didReceiveCoordinatedLayerTreeHostMessage(IPC::Connection&, IPC::Decoder&) = 0;
83 #endif
84
85 #if USE(COORDINATED_GRAPHICS_THREADED)
86     virtual void contentsSizeChanged(const WebCore::IntSize&) { };
87     virtual void didChangeViewportAttributes(WebCore::ViewportAttributes&&) { };
88 #endif
89
90 #if USE(COORDINATED_GRAPHICS)
91     virtual void scheduleAnimation() = 0;
92 #endif
93
94 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK)
95     virtual void setNativeSurfaceHandleForCompositing(uint64_t) { };
96 #endif
97
98 #if USE(COORDINATED_GRAPHICS) || USE(TEXTURE_MAPPER)
99     virtual void deviceOrPageScaleFactorChanged() = 0;
100 #endif
101
102     virtual void setViewOverlayRootLayer(WebCore::GraphicsLayer* viewOverlayRootLayer) { m_viewOverlayRootLayer = viewOverlayRootLayer; }
103
104 protected:
105     explicit LayerTreeHost(WebPage&);
106
107     WebPage& m_webPage;
108     LayerTreeContext m_layerTreeContext;
109     bool m_layerFlushSchedulingEnabled { true };
110     bool m_notifyAfterScheduledLayerFlush { false };
111     bool m_isSuspended { false };
112     bool m_isValid { true };
113     WebCore::GraphicsLayer* m_viewOverlayRootLayer { nullptr };
114 };
115
116 } // namespace WebKit
117
118 #endif // USE(COORDINATED_GRAPHICS) || USE(TEXTURE_MAPPER)
119
120 #endif // LayerTreeHost_h