[Threaded Compositor] Modernize and simplify threaded compositor code
[WebKit-https.git] / Source / WebKit2 / Shared / CoordinatedGraphics / threadedcompositor / CompositingRunLoop.h
1 /*
2  * Copyright (C) 2014 Igalia S.L.
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 CompositingRunLoop_h
27 #define CompositingRunLoop_h
28
29 #if USE(COORDINATED_GRAPHICS_THREADED)
30
31 #include <functional>
32 #include <wtf/FastMalloc.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/RunLoop.h>
35
36 namespace WebKit {
37
38 class CompositingRunLoop {
39     WTF_MAKE_NONCOPYABLE(CompositingRunLoop);
40     WTF_MAKE_FAST_ALLOCATED;
41 public:
42     enum UpdateTiming {
43         Immediate,
44         WaitUntilNextFrame,
45     };
46
47     CompositingRunLoop(std::function<void ()>&&);
48
49     void performTask(NoncopyableFunction<void ()>&&);
50     void performTaskSync(NoncopyableFunction<void ()>&&);
51
52     void startUpdateTimer(UpdateTiming = Immediate);
53
54     void run();
55     void stop();
56
57 private:
58     void updateTimerFired();
59
60     RunLoop& m_runLoop;
61     RunLoop::Timer<CompositingRunLoop> m_updateTimer;
62     std::function<void ()> m_updateFunction;
63     Lock m_dispatchSyncConditionMutex;
64     Condition m_dispatchSyncCondition;
65
66     double m_lastUpdateTime { 0 };
67 };
68
69 } // namespace WebKit
70
71 #endif // USE(COORDINATED_GRAPHICS_THREADED)
72
73 #endif // CompositingRunLoop_h