REGRESSION (iOS WebKit2): requestAnimationFrame fires more than once between layer...
[WebKit-https.git] / Source / WebCore / platform / graphics / DisplayRefreshMonitorManager.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 DisplayRefreshMonitorManager_h
27 #define DisplayRefreshMonitorManager_h
28
29 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
30
31 #include "DisplayRefreshMonitor.h"
32 #include "PlatformScreen.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/NeverDestroyed.h>
35 #include <wtf/RefPtr.h>
36
37 namespace WebCore {
38
39 class DisplayRefreshMonitorManager {
40     friend class NeverDestroyed<DisplayRefreshMonitorManager>;
41 public:
42     static DisplayRefreshMonitorManager& sharedManager();
43     
44     void registerClient(DisplayRefreshMonitorClient*);
45     void unregisterClient(DisplayRefreshMonitorClient*);
46
47     bool scheduleAnimation(DisplayRefreshMonitorClient*);
48     void windowScreenDidChange(PlatformDisplayID, DisplayRefreshMonitorClient*);
49
50 private:
51     friend class DisplayRefreshMonitor;
52     void displayDidRefresh(DisplayRefreshMonitor*);
53     
54     DisplayRefreshMonitorManager() { }
55     virtual ~DisplayRefreshMonitorManager();
56
57     DisplayRefreshMonitor* ensureMonitorForClient(DisplayRefreshMonitorClient*);
58
59     // We know nothing about the values of PlatformDisplayIDs, so use UnsignedWithZeroKeyHashTraits.
60     // FIXME: Since we know nothing about these values, this is not sufficient.
61     // Even with UnsignedWithZeroKeyHashTraits, there are still two special values used for empty and deleted hash table slots.
62     typedef HashMap<uint64_t, RefPtr<DisplayRefreshMonitor>, WTF::IntHash<uint64_t>, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> DisplayRefreshMonitorMap;
63     DisplayRefreshMonitorMap m_monitors;
64 };
65
66 }
67
68 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
69
70 #endif