[chromium] Rename opaqueContentsRegion() to visibleContentOpaqueRegion()
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / TiledLayerChromium.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 TiledLayerChromium_h
27 #define TiledLayerChromium_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "LayerChromium.h"
32 #include "cc/CCLayerTilingData.h"
33 #include "cc/CCTiledLayerImpl.h"
34
35 namespace WebCore {
36 class LayerTextureUpdater;
37 class UpdatableTile;
38
39 class TiledLayerChromium : public LayerChromium {
40 public:
41     enum TilingOption { AlwaysTile, NeverTile, AutoTile };
42
43     virtual ~TiledLayerChromium();
44
45     virtual void updateCompositorResources(GraphicsContext3D*, CCTextureUpdater&);
46     virtual void setIsMask(bool);
47
48     virtual void pushPropertiesTo(CCLayerImpl*);
49
50     virtual bool drawsContent() const;
51     virtual bool needsContentsScale() const;
52
53     virtual IntSize contentBounds() const;
54
55     virtual void setNeedsDisplayRect(const FloatRect&);
56
57     virtual void setIsNonCompositedContent(bool);
58
59     virtual void setLayerTreeHost(CCLayerTreeHost*);
60
61     // Reserves all existing and valid tile textures to protect them from being
62     // recycled by the texture manager.
63     void protectTileTextures(const IntRect& layerRect);
64
65     virtual void reserveTextures();
66
67     virtual Region visibleContentOpaqueRegion() const;
68
69 protected:
70     TiledLayerChromium();
71
72     void updateTileSizeAndTilingOption();
73     void updateBounds();
74
75     // Exposed to subclasses for testing.
76     void setTileSize(const IntSize&);
77     void setTextureFormat(GC3Denum textureFormat) { m_textureFormat = textureFormat; }
78     void setBorderTexelOption(CCLayerTilingData::BorderTexelOption);
79     void setSampledTexelFormat(LayerTextureUpdater::SampledTexelFormat sampledTexelFormat) { m_sampledTexelFormat = sampledTexelFormat; }
80     size_t numPaintedTiles() { return m_tiler->tiles().size(); }
81
82     virtual LayerTextureUpdater* textureUpdater() const = 0;
83     virtual void createTextureUpdaterIfNeeded() = 0;
84
85     // Set invalidations to be potentially repainted during update().
86     void invalidateRect(const IntRect& layerRect);
87
88     // Reset state on tiles that will be used for updating the layer.
89     void resetUpdateState();
90
91     // Prepare data needed to update textures that intersect with layerRect.
92     void prepareToUpdate(const IntRect& layerRect, const CCOcclusionTracker*);
93
94     // Same as above, but this will try to paint additional surrounding content if idle.
95     void prepareToUpdateIdle(const IntRect& layerRect, const CCOcclusionTracker*);
96
97     // After preparing an update, returns true if more pre-painting is needed.
98     bool needsIdlePaint(const IntRect& layerRect);
99
100     IntRect idlePaintRect(const IntRect& visibleLayerRect);
101
102     bool skipsDraw() const { return m_skipsDraw; }
103
104     virtual void protectVisibleTileTextures();
105
106     virtual TextureManager* textureManager() const;
107
108 private:
109     virtual PassOwnPtr<CCLayerImpl> createCCLayerImpl();
110
111     void createTilerIfNeeded();
112     void setTilingOption(TilingOption);
113
114     bool tileOnlyNeedsPartialUpdate(UpdatableTile*);
115     bool tileNeedsBufferedUpdate(UpdatableTile*);
116
117     void prepareToUpdateTiles(bool idle, int left, int top, int right, int bottom, const CCOcclusionTracker*);
118
119     UpdatableTile* tileAt(int, int) const;
120     UpdatableTile* createTile(int, int);
121
122     // Temporary state held between prepareToUpdate() and updateCompositorResources().
123     IntRect m_requestedUpdateTilesRect;
124
125     // State held between prepareToUpdate() and pushPropertiesTo(). This represents the area
126     // of the layer that is actually re-painted by WebKit.
127     IntRect m_paintRect;
128
129     GC3Denum m_textureFormat;
130     bool m_skipsDraw;
131     bool m_skipsIdlePaint;
132     LayerTextureUpdater::SampledTexelFormat m_sampledTexelFormat;
133
134     TilingOption m_tilingOption;
135     OwnPtr<CCLayerTilingData> m_tiler;
136 };
137
138 }
139 #endif // USE(ACCELERATED_COMPOSITING)
140
141 #endif