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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright (C) 2018-2023 Apple 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 INC. 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 INC. 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.
*/
#pragma once
#include "RemoteAcceleratedEffectStack.h"
#include "RemoteLayerBackingStore.h"
#include <WebCore/EventRegion.h>
#include <WebCore/LayerHostingContextIdentifier.h>
#include <WebCore/PlatformLayerIdentifier.h>
#include <WebCore/RenderingResourceIdentifier.h>
#include <WebCore/ScrollTypes.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/Vector.h>
OBJC_CLASS CALayer;
OBJC_CLASS NSString;
#if PLATFORM(IOS_FAMILY)
OBJC_CLASS UIView;
#endif
namespace WebKit {
class RemoteLayerTreeHost;
class RemoteLayerTreeScrollbars;
class RemoteLayerTreeNode final : public RefCountedAndCanMakeWeakPtr<RemoteLayerTreeNode> {
WTF_MAKE_TZONE_ALLOCATED(RemoteLayerTreeNode);
public:
static Ref<RemoteLayerTreeNode> create(WebCore::PlatformLayerIdentifier, Markable<WebCore::LayerHostingContextIdentifier>, RetainPtr<CALayer>);
#if PLATFORM(IOS_FAMILY)
static Ref<RemoteLayerTreeNode> create(WebCore::PlatformLayerIdentifier, Markable<WebCore::LayerHostingContextIdentifier>, RetainPtr<UIView>);
#endif
~RemoteLayerTreeNode();
static Ref<RemoteLayerTreeNode> createWithPlainLayer(WebCore::PlatformLayerIdentifier);
CALayer *layer() const { return m_layer.get(); }
#if ENABLE(GAZE_GLOW_FOR_INTERACTION_REGIONS) || HAVE(CORE_ANIMATION_SEPARATED_LAYERS)
struct VisibleRectMarkableTraits {
static bool isEmptyValue(const WebCore::FloatRect& value)
{
return value.isEmpty();
}
static WebCore::FloatRect emptyValue()
{
return { };
}
};
const Markable<WebCore::FloatRect, VisibleRectMarkableTraits> visibleRect() const { return m_visibleRect; }
void setVisibleRect(const WebCore::FloatRect& value) { m_visibleRect = value; }
#endif
#if ENABLE(GAZE_GLOW_FOR_INTERACTION_REGIONS)
CALayer *ensureInteractionRegionsContainer();
void removeInteractionRegionsContainer();
void updateInteractionRegionAfterHierarchyChange();
#endif
#if HAVE(CORE_ANIMATION_SEPARATED_LAYERS)
bool shouldBeSeparated() const { return m_shouldBeSeparated; }
void setShouldBeSeparated(bool value) { m_shouldBeSeparated = value; }
#endif
#if PLATFORM(IOS_FAMILY)
UIView *uiView() const { return m_uiView.get(); }
#endif
WebCore::PlatformLayerIdentifier layerID() const { return m_layerID; }
const WebCore::EventRegion& eventRegion() const { return m_eventRegion; }
void setEventRegion(const WebCore::EventRegion&);
// Non-ancestor scroller that controls positioning of the layer.
std::optional<WebCore::PlatformLayerIdentifier> actingScrollContainerID() const { return m_actingScrollContainerID.asOptional(); }
// Ancestor scrollers that don't affect positioning of the layer.
const Vector<WebCore::PlatformLayerIdentifier>& stationaryScrollContainerIDs() const { return m_stationaryScrollContainerIDs; }
void setActingScrollContainerID(std::optional<WebCore::PlatformLayerIdentifier> value) { m_actingScrollContainerID = value; }
void setStationaryScrollContainerIDs(Vector<WebCore::PlatformLayerIdentifier>&& value) { m_stationaryScrollContainerIDs = WTFMove(value); }
void detachFromParent();
static std::optional<WebCore::PlatformLayerIdentifier> layerID(CALayer *);
static RemoteLayerTreeNode* forCALayer(CALayer *);
static NSString *appendLayerDescription(NSString *description, CALayer *);
#if ENABLE(SCROLLING_THREAD)
std::optional<WebCore::ScrollingNodeID> scrollingNodeID() const { return m_scrollingNodeID; }
void setScrollingNodeID(std::optional<WebCore::ScrollingNodeID> nodeID) { m_scrollingNodeID = nodeID; }
#endif
Markable<WebCore::LayerHostingContextIdentifier> remoteContextHostingIdentifier() const { return m_remoteContextHostingIdentifier; }
Markable<WebCore::LayerHostingContextIdentifier> remoteContextHostedIdentifier() const { return m_remoteContextHostedIdentifier; }
void setRemoteContextHostedIdentifier(WebCore::LayerHostingContextIdentifier identifier) { m_remoteContextHostedIdentifier = identifier; }
void addToHostingNode(RemoteLayerTreeNode&);
void removeFromHostingNode();
// A cached CAIOSurface object to retain CA render resources.
struct CachedContentsBuffer {
BufferAndBackendInfo imageBufferInfo;
RetainPtr<id> buffer;
};
Vector<CachedContentsBuffer> takeCachedContentsBuffers() { return std::exchange(m_cachedContentsBuffers, { }); }
void setCachedContentsBuffers(Vector<CachedContentsBuffer>&& buffers)
{
m_cachedContentsBuffers = WTFMove(buffers);
}
std::optional<WebCore::RenderingResourceIdentifier> asyncContentsIdentifier() const
{
return m_asyncContentsIdentifier;
}
void setAsyncContentsIdentifier(std::optional<WebCore::RenderingResourceIdentifier> identifier)
{
m_asyncContentsIdentifier = identifier;
}
#if ENABLE(THREADED_ANIMATION_RESOLUTION)
void setAcceleratedEffectsAndBaseValues(const WebCore::AcceleratedEffects&, const WebCore::AcceleratedEffectValues&, RemoteLayerTreeHost&);
const RemoteAcceleratedEffectStack* effectStack() const { return m_effectStack.get(); }
RefPtr<RemoteAcceleratedEffectStack> takeEffectStack() { return std::exchange(m_effectStack, nullptr); }
#endif
bool backdropRootIsOpaque() const { return m_backdropRootIsOpaque; }
void setBackdropRootIsOpaque(bool backdropRootIsOpaque) { m_backdropRootIsOpaque = backdropRootIsOpaque; }
private:
RemoteLayerTreeNode(WebCore::PlatformLayerIdentifier, Markable<WebCore::LayerHostingContextIdentifier>, RetainPtr<CALayer>);
#if PLATFORM(IOS_FAMILY)
RemoteLayerTreeNode(WebCore::PlatformLayerIdentifier, Markable<WebCore::LayerHostingContextIdentifier>, RetainPtr<UIView>);
#endif
void initializeLayer();
WebCore::PlatformLayerIdentifier m_layerID;
Markable<WebCore::LayerHostingContextIdentifier> m_remoteContextHostingIdentifier;
Markable<WebCore::LayerHostingContextIdentifier> m_remoteContextHostedIdentifier;
RetainPtr<CALayer> m_layer;
#if ENABLE(GAZE_GLOW_FOR_INTERACTION_REGIONS) || HAVE(CORE_ANIMATION_SEPARATED_LAYERS)
Markable<WebCore::FloatRect, VisibleRectMarkableTraits> m_visibleRect;
#endif
#if ENABLE(GAZE_GLOW_FOR_INTERACTION_REGIONS)
void repositionInteractionRegionsContainerIfNeeded();
enum class InteractionRegionsInSubtree : bool { Yes, Unknown };
void propagateInteractionRegionsChangeInHierarchy(InteractionRegionsInSubtree);
bool hasInteractionRegions() const;
bool hasInteractionRegionsDescendant() const { return m_hasInteractionRegionsDescendant; }
void setHasInteractionRegionsDescendant(bool value) { m_hasInteractionRegionsDescendant = value; }
bool m_hasInteractionRegionsDescendant { false };
RetainPtr<UIView> m_interactionRegionsContainer;
#endif
#if HAVE(CORE_ANIMATION_SEPARATED_LAYERS)
bool m_shouldBeSeparated { false };
#endif
#if PLATFORM(IOS_FAMILY)
RetainPtr<UIView> m_uiView;
#endif
WebCore::EventRegion m_eventRegion;
#if ENABLE(SCROLLING_THREAD)
Markable<WebCore::ScrollingNodeID> m_scrollingNodeID;
#endif
Markable<WebCore::PlatformLayerIdentifier> m_actingScrollContainerID;
Vector<WebCore::PlatformLayerIdentifier> m_stationaryScrollContainerIDs;
Vector<CachedContentsBuffer> m_cachedContentsBuffers;
std::optional<WebCore::RenderingResourceIdentifier> m_asyncContentsIdentifier;
#if ENABLE(THREADED_ANIMATION_RESOLUTION)
RefPtr<RemoteAcceleratedEffectStack> m_effectStack;
#endif
bool m_backdropRootIsOpaque { false };
};
}
|
