4fc681eb59bb607799cb7127bd5360e78f21a4b6
[WebKit-https.git] / Source / WebCore / platform / graphics / texmap / coordinated / CoordinatedGraphicsLayer.h
1 /*
2  Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
3
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  Library General Public License for more details.
13
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB.  If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18  */
19
20
21 #ifndef CoordinatedGraphicsLayer_h
22 #define CoordinatedGraphicsLayer_h
23
24 #if USE(COORDINATED_GRAPHICS)
25
26 #include "CoordinatedGraphicsState.h"
27 #include "CoordinatedImageBacking.h"
28 #include "FloatPoint3D.h"
29 #include "GraphicsLayer.h"
30 #include "GraphicsLayerTransform.h"
31 #include "Image.h"
32 #include "IntSize.h"
33 #include "NicosiaBuffer.h"
34 #include "TextureMapperAnimation.h"
35 #include "TiledBackingStore.h"
36 #include "TiledBackingStoreClient.h"
37 #include "TransformationMatrix.h"
38 #include <wtf/text/StringHash.h>
39
40 namespace Nicosia {
41 class PaintingEngine;
42 }
43
44 namespace WebCore {
45 class CoordinatedGraphicsLayer;
46 class TextureMapperAnimations;
47
48 class CoordinatedGraphicsLayerClient {
49 public:
50     virtual bool isFlushingLayerChanges() const = 0;
51     virtual FloatRect visibleContentsRect() const = 0;
52     virtual Ref<CoordinatedImageBacking> createImageBackingIfNeeded(Image&) = 0;
53     virtual void detachLayer(CoordinatedGraphicsLayer*) = 0;
54     virtual Ref<Nicosia::Buffer> getCoordinatedBuffer(const IntSize&, Nicosia::Buffer::Flags, uint32_t&, IntRect&) = 0;
55     virtual Nicosia::PaintingEngine& paintingEngine() = 0;
56
57     virtual void syncLayerState(CoordinatedLayerID, CoordinatedGraphicsLayerState&) = 0;
58 };
59
60 class WEBCORE_EXPORT CoordinatedGraphicsLayer : public GraphicsLayer
61     , public TiledBackingStoreClient
62     , public CoordinatedImageBacking::Host {
63 public:
64     explicit CoordinatedGraphicsLayer(Type, GraphicsLayerClient&);
65     virtual ~CoordinatedGraphicsLayer();
66
67     PlatformLayerID primaryLayerID() const override { return id(); }
68
69     // Reimplementations from GraphicsLayer.h.
70     bool setChildren(const Vector<GraphicsLayer*>&) override;
71     void addChild(GraphicsLayer*) override;
72     void addChildAtIndex(GraphicsLayer*, int) override;
73     void addChildAbove(GraphicsLayer*, GraphicsLayer*) override;
74     void addChildBelow(GraphicsLayer*, GraphicsLayer*) override;
75     bool replaceChild(GraphicsLayer*, GraphicsLayer*) override;
76     void removeFromParent() override;
77     void setPosition(const FloatPoint&) override;
78     void setAnchorPoint(const FloatPoint3D&) override;
79     void setSize(const FloatSize&) override;
80     void setTransform(const TransformationMatrix&) override;
81     void setChildrenTransform(const TransformationMatrix&) override;
82     void setPreserves3D(bool) override;
83     void setMasksToBounds(bool) override;
84     void setDrawsContent(bool) override;
85     void setContentsVisible(bool) override;
86     void setContentsOpaque(bool) override;
87     void setBackfaceVisibility(bool) override;
88     void setOpacity(float) override;
89     void setContentsRect(const FloatRect&) override;
90     void setContentsTilePhase(const FloatSize&) override;
91     void setContentsTileSize(const FloatSize&) override;
92     void setContentsToImage(Image*) override;
93     void setContentsToSolidColor(const Color&) override;
94     void setShowDebugBorder(bool) override;
95     void setShowRepaintCounter(bool) override;
96     bool shouldDirectlyCompositeImage(Image*) const override;
97     void setContentsToPlatformLayer(PlatformLayer*, ContentsLayerPurpose) override;
98     void setMaskLayer(GraphicsLayer*) override;
99     void setReplicatedByLayer(GraphicsLayer*) override;
100     void setNeedsDisplay() override;
101     void setNeedsDisplayInRect(const FloatRect&, ShouldClipToLayer = ClipToLayer) override;
102     void setContentsNeedsDisplay() override;
103     void deviceOrPageScaleFactorChanged() override;
104     void flushCompositingState(const FloatRect&) override;
105     void flushCompositingStateForThisLayerOnly() override;
106     bool setFilters(const FilterOperations&) override;
107     bool addAnimation(const KeyframeValueList&, const FloatSize&, const Animation*, const String&, double) override;
108     void pauseAnimation(const String&, double) override;
109     void removeAnimation(const String&) override;
110     void suspendAnimations(MonotonicTime) override;
111     void resumeAnimations() override;
112     bool usesContentsLayer() const override { return m_platformLayer || m_compositedImage; }
113
114     void syncPendingStateChangesIncludingSubLayers();
115     void updateContentBuffersIncludingSubLayers();
116
117     FloatPoint computePositionRelativeToBase();
118     void computePixelAlignment(FloatPoint& position, FloatSize&, FloatPoint3D& anchorPoint, FloatSize& alignmentOffset);
119
120     void setVisibleContentRectTrajectoryVector(const FloatPoint&);
121
122     CoordinatedLayerID id() const { return m_id; }
123
124     void setFixedToViewport(bool isFixed);
125
126     IntRect coverRect() const { return m_mainBackingStore ? m_mainBackingStore->mapToContents(m_mainBackingStore->coverRect()) : IntRect(); }
127     IntRect transformedVisibleRect();
128
129     // TiledBackingStoreClient
130     void tiledBackingStoreHasPendingTileCreation() override;
131     void createTile(uint32_t tileID, float) override;
132     void updateTile(uint32_t tileID, const SurfaceUpdateInfo&, const IntRect&) override;
133     void removeTile(uint32_t tileID) override;
134
135     void setCoordinator(CoordinatedGraphicsLayerClient*);
136
137     void setNeedsVisibleRectAdjustment();
138     void purgeBackingStores();
139
140     CoordinatedGraphicsLayer* findFirstDescendantWithContentsRecursively();
141
142 private:
143     bool isCoordinatedGraphicsLayer() const override { return true; }
144
145     void syncPlatformLayer();
146     void updatePlatformLayer();
147
148     void setDebugBorder(const Color&, float width) override;
149
150     bool fixedToViewport() const { return m_fixedToViewport; }
151
152     void didChangeLayerState();
153     void didChangeAnimations();
154     void didChangeGeometry();
155     void didChangeChildren();
156     void didChangeFilters();
157     void didChangeImageBacking();
158     void didUpdateTileBuffers();
159
160     void resetLayerState();
161     void syncLayerState();
162     void syncAnimations();
163     void syncChildren();
164     void syncFilters();
165     void syncImageBacking();
166     void computeTransformedVisibleRect();
167     void updateContentBuffers();
168
169     void createBackingStore();
170     void releaseImageBackingIfNeeded();
171
172     void notifyFlushRequired();
173
174     // CoordinatedImageBacking::Host
175     bool imageBackingVisible() override;
176     bool shouldHaveBackingStore() const;
177     bool selfOrAncestorHasActiveTransformAnimation() const;
178     bool selfOrAncestorHaveNonAffineTransforms();
179     void adjustContentsScale();
180
181     void setShouldUpdateVisibleRect();
182     float effectiveContentsScale();
183
184     void animationStartedTimerFired();
185
186     bool filtersCanBeComposited(const FilterOperations&) const;
187
188     CoordinatedLayerID m_id;
189     CoordinatedGraphicsLayerState m_layerState;
190     GraphicsLayerTransform m_layerTransform;
191     TransformationMatrix m_cachedInverseTransform;
192     FloatSize m_pixelAlignmentOffset;
193     FloatSize m_adjustedSize;
194     FloatPoint m_adjustedPosition;
195     FloatPoint3D m_adjustedAnchorPoint;
196
197 #ifndef NDEBUG
198     bool m_isPurging;
199 #endif
200     bool m_shouldUpdateVisibleRect: 1;
201     bool m_shouldSyncLayerState: 1;
202     bool m_shouldSyncChildren: 1;
203     bool m_shouldSyncFilters: 1;
204     bool m_shouldSyncImageBacking: 1;
205     bool m_shouldSyncAnimations: 1;
206     bool m_fixedToViewport : 1;
207     bool m_movingVisibleRect : 1;
208     bool m_pendingContentsScaleAdjustment : 1;
209     bool m_pendingVisibleRectAdjustment : 1;
210 #if USE(COORDINATED_GRAPHICS_THREADED)
211     bool m_shouldSyncPlatformLayer : 1;
212     bool m_shouldUpdatePlatformLayer : 1;
213 #endif
214
215     CoordinatedGraphicsLayerClient* m_coordinator;
216     std::unique_ptr<TiledBackingStore> m_mainBackingStore;
217     std::unique_ptr<TiledBackingStore> m_previousBackingStore;
218
219     struct {
220         bool completeLayer { false };
221         Vector<FloatRect, 32> rects;
222     } m_needsDisplay;
223
224     RefPtr<Image> m_compositedImage;
225     NativeImagePtr m_compositedNativeImagePtr;
226     RefPtr<CoordinatedImageBacking> m_coordinatedImageBacking;
227
228     PlatformLayer* m_platformLayer;
229     Timer m_animationStartedTimer;
230     TextureMapperAnimations m_animations;
231     MonotonicTime m_lastAnimationStartTime;
232 };
233
234 } // namespace WebCore
235
236 SPECIALIZE_TYPE_TRAITS_GRAPHICSLAYER(WebCore::CoordinatedGraphicsLayer, isCoordinatedGraphicsLayer())
237
238 #endif // USE(COORDINATED_GRAPHICS)
239
240 #endif // CoordinatedGraphicsLayer_h