22fa57231cec8fdcc3423d7b1100919dfdcdd6c5
[WebKit-https.git] / Source / WebCore / platform / graphics / DisplayRefreshMonitorClient.h
1 /*
2  * Copyright (C) 2010, 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DisplayRefreshMonitorClient_h
27 #define DisplayRefreshMonitorClient_h
28
29 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
30
31 #include "PlatformScreen.h"
32 #include <wtf/Optional.h>
33
34 namespace WebCore {
35
36 class DisplayRefreshMonitor;
37 class DisplayRefreshMonitorManager;
38
39 class DisplayRefreshMonitorClient {
40 public:
41     DisplayRefreshMonitorClient();
42     virtual ~DisplayRefreshMonitorClient();
43
44     // Always called on the main thread.
45     virtual void displayRefreshFired(double timestamp) = 0;
46
47     // Returning nullopt indicates that WebCore should create whatever DisplayRefreshMonitor it deems
48     // most appropriate for the current platform. Returning nullptr indicates that we should not try to
49     // create a DisplayRefreshMonitor at all (and should instead fall back to using a timer).
50     virtual Optional<RefPtr<DisplayRefreshMonitor>> createDisplayRefreshMonitor(PlatformDisplayID) const = 0;
51
52     PlatformDisplayID displayID() const { return m_displayID; }
53     bool hasDisplayID() const { return m_displayIDIsSet; }
54     void setDisplayID(PlatformDisplayID displayID)
55     {
56         m_displayID = displayID;
57         m_displayIDIsSet = true;
58     }
59
60     void setIsScheduled(bool isScheduled) { m_scheduled = isScheduled; }
61     bool isScheduled() const { return m_scheduled; }
62
63     void fireDisplayRefreshIfNeeded(double timestamp);
64
65 private:
66     bool m_scheduled;
67     bool m_displayIDIsSet;
68     PlatformDisplayID m_displayID;
69 };
70
71 }
72
73 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
74
75 #endif