ffa9ba953e707a852a81e1061e52ff69072cf2f1
[WebKit-https.git] / Source / WebCore / platform / graphics / TiledBacking.h
1 /*
2  * Copyright (C) 2012 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. 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 TiledBacking_h
27 #define TiledBacking_h
28
29 #if PLATFORM(MAC)
30 OBJC_CLASS CALayer;
31 #endif
32
33 namespace WebCore {
34
35 class IntRect;
36
37 enum ScrollingModeIndication {
38     MainThreadScrollingBecauseOfStyleIndication,
39     MainThreadScrollingBecauseOfEventHandlersIndication,
40     ThreadedScrollingIndication
41 };
42
43 class TiledBacking {
44 public:
45     virtual ~TiledBacking() { }
46
47     virtual void setVisibleRect(const FloatRect&) = 0;
48     virtual FloatRect visibleRect() const = 0;
49
50     virtual void setExposedRect(const FloatRect&) = 0;
51     virtual void setClipsToExposedRect(bool) = 0;
52     virtual bool clipsToExposedRect() = 0;
53
54     virtual void prepopulateRect(const FloatRect&) = 0;
55
56     virtual void setIsInWindow(bool) = 0;
57
58     enum {
59         CoverageForVisibleArea = 0,
60         CoverageForVerticalScrolling = 1 << 0,
61         CoverageForHorizontalScrolling = 1 << 1,
62         CoverageForSlowScrolling = 1 << 2, // Indicates that we expect to paint a lot on scrolling.
63         CoverageForScrolling = CoverageForVerticalScrolling | CoverageForHorizontalScrolling
64     };
65     typedef unsigned TileCoverage;
66
67     virtual void setTileCoverage(TileCoverage) = 0;
68     virtual TileCoverage tileCoverage() const = 0;
69
70     virtual IntSize tileSize() const = 0;
71
72     virtual void forceRepaint() = 0;
73
74     virtual void setScrollingPerformanceLoggingEnabled(bool) = 0;
75     virtual bool scrollingPerformanceLoggingEnabled() const = 0;
76     
77     virtual void setAggressivelyRetainsTiles(bool) = 0;
78     virtual bool aggressivelyRetainsTiles() const = 0;
79     
80     virtual void setUnparentsOffscreenTiles(bool) = 0;
81     virtual bool unparentsOffscreenTiles() const = 0;
82     
83     virtual double retainedTileBackingStoreMemory() const = 0;
84
85     // Exposed for testing
86     virtual IntRect tileCoverageRect() const = 0;
87     virtual IntRect tileGridExtent() const = 0;
88     virtual void setScrollingModeIndication(ScrollingModeIndication) = 0;
89
90 #if PLATFORM(MAC)
91     virtual CALayer *tiledScrollingIndicatorLayer() = 0;
92 #endif
93 };
94
95 } // namespace WebCore
96
97 #endif // TiledBacking_h