[iOS] Throttle painting using a UI-process-side CADisplayLink
[WebKit-https.git] / Source / WebKit2 / UIProcess / mac / RemoteLayerTreeDrawingAreaProxy.h
1 /*
2  * Copyright (C) 2012-2014 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 RemoteLayerTreeDrawingAreaProxy_h
27 #define RemoteLayerTreeDrawingAreaProxy_h
28
29 #include "DrawingAreaProxy.h"
30 #include "RemoteLayerTreeHost.h"
31 #include <WebCore/FloatPoint.h>
32 #include <WebCore/IntPoint.h>
33 #include <WebCore/IntSize.h>
34
35 OBJC_CLASS OneShotDisplayLinkHandler;
36
37 namespace WebKit {
38
39 class RemoteLayerTreeTransaction;
40 class RemoteScrollingCoordinatorTransaction;
41
42 class RemoteLayerTreeDrawingAreaProxy : public DrawingAreaProxy {
43 public:
44     explicit RemoteLayerTreeDrawingAreaProxy(WebPageProxy*);
45     virtual ~RemoteLayerTreeDrawingAreaProxy();
46
47     const RemoteLayerTreeHost& remoteLayerTreeHost() const { return m_remoteLayerTreeHost; }
48
49     void acceleratedAnimationDidStart(uint64_t layerID, const String& key, double startTime);
50
51     uint64_t nextLayerTreeTransactionID() const { return m_pendingLayerTreeTransactionID + 1; }
52     uint64_t lastCommittedLayerTreeTransactionID() const { return m_transactionIDForPendingCACommit; }
53
54     void didRefreshDisplay(double timestamp);
55
56 private:
57     virtual void sizeDidChange() override;
58     virtual void deviceScaleFactorDidChange() override;
59     virtual void didUpdateGeometry() override;
60     
61     // For now, all callbacks are called before committing changes, because that's what the only client requires.
62     // Once we have other callbacks, it may make sense to have a before-commit/after-commit option.
63     virtual void dispatchAfterEnsuringDrawing(std::function<void (CallbackBase::Error)>) override;
64
65     WebCore::FloatRect scaledExposedRect() const;
66
67 #if PLATFORM(MAC)
68     virtual void setExposedRect(const WebCore::FloatRect&) override;
69 #endif
70
71     float indicatorScale(WebCore::IntSize contentsSize) const;
72     virtual void updateDebugIndicator() override;
73     void updateDebugIndicator(WebCore::IntSize contentsSize, bool rootLayerChanged, float scale);
74     void updateDebugIndicatorPosition();
75     void initializeDebugIndicator();
76
77     virtual void waitForDidUpdateViewState() override;
78     
79     WebCore::FloatPoint indicatorLocation() const;
80
81     // IPC::MessageReceiver
82     virtual void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&) override;
83
84     // Message handlers
85     void willCommitLayerTree(uint64_t transactionID);
86     void commitLayerTree(const RemoteLayerTreeTransaction&, const RemoteScrollingCoordinatorTransaction&);
87     
88     void sendUpdateGeometry();
89
90     RemoteLayerTreeHost m_remoteLayerTreeHost;
91     bool m_isWaitingForDidUpdateGeometry;
92
93     WebCore::IntSize m_lastSentSize;
94     WebCore::IntSize m_lastSentLayerPosition;
95
96     std::unique_ptr<RemoteLayerTreeHost> m_debugIndicatorLayerTreeHost;
97     RetainPtr<CALayer> m_tileMapHostLayer;
98     RetainPtr<CALayer> m_exposedRectIndicatorLayer;
99
100     uint64_t m_pendingLayerTreeTransactionID;
101     uint64_t m_lastVisibleTransactionID;
102     uint64_t m_transactionIDForPendingCACommit;
103
104     CallbackMap m_callbacks;
105
106     RetainPtr<OneShotDisplayLinkHandler> m_displayLinkHandler;
107 };
108
109 DRAWING_AREA_PROXY_TYPE_CASTS(RemoteLayerTreeDrawingAreaProxy, type() == DrawingAreaTypeRemoteLayerTree);
110
111 } // namespace WebKit
112
113 #endif // RemoteLayerTreeDrawingAreaProxy_h