b6ee8d68ffdf93d667c3b7aa2bcf5c193bd8726d
[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
33 namespace WebCore {
34
35 class DisplayRefreshMonitor;
36 class DisplayRefreshMonitorManager;
37
38 class DisplayRefreshMonitorClient {
39 public:
40     DisplayRefreshMonitorClient();
41     virtual ~DisplayRefreshMonitorClient();
42
43     // Always called on the main thread.
44     virtual void displayRefreshFired(double timestamp) = 0;
45
46     virtual PassRefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const = 0;
47
48     PlatformDisplayID displayID() const { return m_displayID; }
49     bool hasDisplayID() const { return m_displayIDIsSet; }
50     void setDisplayID(PlatformDisplayID displayID)
51     {
52         m_displayID = displayID;
53         m_displayIDIsSet = true;
54     }
55
56     void setIsScheduled(bool isScheduled) { m_scheduled = isScheduled; }
57     bool isScheduled() const { return m_scheduled; }
58
59     void fireDisplayRefreshIfNeeded(double timestamp);
60
61 private:
62     bool m_scheduled;
63     bool m_displayIDIsSet;
64     PlatformDisplayID m_displayID;
65 };
66
67 }
68
69 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
70
71 #endif