1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebLayerTreeView_h
#define WebLayerTreeView_h
#include "WebColor.h"
#include "WebCommon.h"
#include "WebFloatPoint.h"
#include "WebNonCopyable.h"
#include "WebPrivateOwnPtr.h"
#include "WebSize.h"
class SkBitmap;
namespace WebKit {
class WebGraphicsContext3D;
class WebLayer;
class WebLayerTreeViewClient;
struct WebPoint;
struct WebRect;
struct WebRenderingStats;
class WebLayerTreeView {
public:
struct Settings {
Settings()
: acceleratePainting(false)
, showDebugBorders(false)
, showFPSCounter(false)
, showPlatformLayerTree(false)
, showPaintRects(false)
, renderVSyncEnabled(true)
, perTilePaintingEnabled(false)
, partialSwapEnabled(false)
, acceleratedAnimationEnabled(true)
, pageScalePinchZoomEnabled(false)
, refreshRate(0)
, defaultTileSize(WebSize(256, 256))
, maxUntiledLayerSize(WebSize(512, 512))
{
}
bool acceleratePainting;
bool showDebugBorders;
bool showFPSCounter;
bool showPlatformLayerTree;
bool showPaintRects;
bool renderVSyncEnabled;
bool perTilePaintingEnabled;
bool partialSwapEnabled;
bool acceleratedAnimationEnabled;
bool pageScalePinchZoomEnabled;
double refreshRate;
WebSize defaultTileSize;
WebSize maxUntiledLayerSize;
};
#define WEBLAYERTREEVIEW_IS_PURE_VIRTUAL
// Attempts to initialize this WebLayerTreeView with the given client, root layer, and settings.
// If initialization fails, this will return nil.
WEBKIT_EXPORT static WebLayerTreeView* create(WebLayerTreeViewClient*, const WebLayer& root, const Settings&);
virtual ~WebLayerTreeView() { }
// Initialization and lifecycle --------------------------------------
// Indicates that the compositing surface used by this WebLayerTreeView is ready to use.
// A WebLayerTreeView may request a context from its client before the surface is ready,
// but it won't attempt to use it.
virtual void setSurfaceReady() = 0;
// Sets the root of the tree. The root is set by way of the constructor.
virtual void setRootLayer(const WebLayer&) = 0;
virtual void clearRootLayer() = 0;
// View properties ---------------------------------------------------
virtual void setViewportSize(const WebSize& layoutViewportSize, const WebSize& deviceViewportSize = WebSize()) = 0;
// Gives the viewport size in layer space.
virtual WebSize layoutViewportSize() const = 0;
// Gives the viewport size in physical device pixels (may be different
// from the above if there exists page scale, device scale or fixed layout
// mode).
virtual WebSize deviceViewportSize() const = 0;
// Gives the corrected location for an event, accounting for the pinch-zoom transformation
// in the compositor.
virtual WebFloatPoint adjustEventPointForPinchZoom(const WebFloatPoint&) const = 0;
virtual void setDeviceScaleFactor(float) = 0;
virtual float deviceScaleFactor() const = 0;
// Sets the background color for the viewport.
virtual void setBackgroundColor(WebColor) = 0;
// Sets the background transparency for the viewport. The default is 'false'.
virtual void setHasTransparentBackground(bool) = 0;
// Sets whether this view is visible. In threaded mode, a view that is not visible will not
// composite or trigger updateAnimations() or layout() calls until it becomes visible.
virtual void setVisible(bool) = 0;
// Sets the current page scale factor and minimum / maximum limits. Both limits are initially 1 (no page scale allowed).
virtual void setPageScaleFactorAndLimits(float pageScaleFactor, float minimum, float maximum) = 0;
// Starts an animation of the page scale to a target scale factor and scroll offset.
// If useAnchor is true, destination is a point on the screen that will remain fixed for the duration of the animation.
// If useAnchor is false, destination is the final top-left scroll position.
virtual void startPageScaleAnimation(const WebPoint& destination, bool useAnchor, float newPageScale, double durationSec) = 0;
// Flow control and scheduling ---------------------------------------
// Requests an updateAnimations() call.
virtual void setNeedsAnimate() = 0;
// Indicates that the view needs to be redrawn. This is typically used when the frontbuffer is damaged.
virtual void setNeedsRedraw() = 0;
// Indicates whether a commit is pending.
virtual bool commitRequested() const = 0;
// Triggers a compositing pass. If the compositor thread was not
// enabled via WebCompositorSupport::initialize, the compositing pass happens
// immediately. If it is enabled, the compositing pass will happen at a
// later time. Before the compositing pass happens (i.e. before composite()
// returns when the compositor thread is disabled), WebContentLayers will be
// asked to paint their dirty region, through
// WebContentLayerClient::paintContents.
virtual void composite() = 0;
// Immediately update animations. This should only be used when frame scheduling is handled by
// the WebLayerTreeView user and not internally by the compositor, meaning only in single-threaded
// mode.
virtual void updateAnimations(double frameBeginTime) = 0;
// Composites and attempts to read back the result into the provided
// buffer. If it wasn't possible, e.g. due to context lost, will return
// false. Pixel format is 32bit (RGBA), and the provided buffer must be
// large enough contain viewportSize().width() * viewportSize().height()
// pixels. The WebLayerTreeView does not assume ownership of the buffer.
// The buffer is not modified if the false is returned.
virtual bool compositeAndReadback(void *pixels, const WebRect&) = 0;
// Blocks until the most recently composited frame has finished rendering on the GPU.
// This can have a significant performance impact and should be used with care.
virtual void finishAllRendering() = 0;
// Prevents updates to layer tree from becoming visible.
virtual void setDeferCommits(bool deferCommits) { }
// Debugging / dangerous ---------------------------------------------
// Fills in a WebRenderingStats struct containing information about the state of the compositor.
// This call is relatively expensive in threaded mode as it blocks on the compositor thread.
virtual void renderingStats(WebRenderingStats&) const = 0;
// Toggles the FPS counter in the HUD layer
virtual void setShowFPSCounter(bool) { }
// Toggles the paint rects in the HUD layer
virtual void setShowPaintRects(bool) { }
// Provides a font atlas to use for debug visualizations. The atlas must be a bitmap containing glyph data, a table of
// ASCII character values to a subrectangle of the atlas representing the corresponding glyph, and the glyph height.
virtual void setFontAtlas(WebRect asciiToRectTable[128], const SkBitmap&, int fontHeight) { }
// Simulates a lost context. For testing only.
virtual void loseCompositorContext(int numTimes) = 0;
};
} // namespace WebKit
#endif // WebLayerTreeView_h
|
