68e04455e694d9ba76fe0309519807adc4f13d7b
[WebKit.git] / Source / WebCore / platform / graphics / chromium / RateLimiter.h
1 /*
2  * Copyright (C) 2011 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef RateLimiter_h
27 #define RateLimiter_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "Timer.h"
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37 class GraphicsContext3D;
38
39 class RateLimiterClient {
40 public:
41     virtual void rateLimit() = 0;
42 };
43
44 // A class containing a timer, which calls rateLimitCHROMIUM on expiry
45 class RateLimiter : public RefCounted<RateLimiter> {
46 public:
47     static PassRefPtr<RateLimiter> create(GraphicsContext3D*, RateLimiterClient*);
48     ~RateLimiter();
49
50     void start();
51     void stop();
52
53 private:
54     RateLimiter(GraphicsContext3D*, RateLimiterClient*);
55     RefPtr<GraphicsContext3D> m_context;
56     bool m_contextSupportsRateLimitingExtension;
57     Timer<RateLimiter> m_timer;
58     void rateLimitContext(Timer<RateLimiter>*);
59     RateLimiterClient *m_client;
60 };
61
62 }
63 #endif // USE(ACCELERATED_COMPOSITING)
64
65 #endif