Changeset 285205 in webkit

Timestamp:

Nov 3, 2021, 7:37:04 AM (5 years ago)

Author:

Chris Lord

Message:

[GTK][WPE] Use the display refresh to drive scrolling animations (sync scroll)
​https://bugs.webkit.org/show_bug.cgi?id=232077

Reviewed by Simon Fraser.

Service sync scroll animations as part of the scroll phase in
Page::updateRendering, which is driven by the display refresh.

No new tests, covered by existing tests.

• dom/Document.cpp:

(WebCore::serviceScrollAnimationForScrollableArea):
(WebCore::Document::runScrollSteps):

• page/FrameView.cpp:

(WebCore::FrameView::didStartScrollAnimation):

• page/FrameView.h:
• platform/ScrollAnimator.cpp:

(WebCore::ScrollAnimator::ScrollAnimator):
(WebCore::ScrollAnimator::startAnimationCallback):
(WebCore::ScrollAnimator::stopAnimationCallback):
(WebCore::ScrollAnimator::serviceScrollAnimation):
(WebCore::ScrollAnimator::scrollControllerAnimationTimerFired): Deleted.

• platform/ScrollAnimator.h:
• platform/ScrollableArea.h:

(WebCore::ScrollableArea::didStartScrollAnimation):

• platform/ScrollingEffectsController.cpp:

(WebCore::ScrollingEffectsController::retargetAnimatedScrollBy):

• rendering/RenderLayerScrollableArea.cpp:

(WebCore::RenderLayerScrollableArea::didStartScrollAnimation):

• rendering/RenderLayerScrollableArea.h:
• rendering/RenderListBox.cpp:

(WebCore::RenderListBox::didStartScrollAnimation):

• rendering/RenderListBox.h:

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• dom/Document.cpp (modified) (2 diffs)
• page/FrameView.cpp (modified) (1 diff)
• page/FrameView.h (modified) (1 diff)
• platform/ScrollAnimator.cpp (modified) (3 diffs)
• platform/ScrollAnimator.h (modified) (3 diffs)
• platform/ScrollableArea.h (modified) (2 diffs)
• platform/ScrollingEffectsController.cpp (modified) (1 diff)
• rendering/RenderLayerScrollableArea.cpp (modified) (1 diff)
• rendering/RenderLayerScrollableArea.h (modified) (1 diff)
• rendering/RenderListBox.cpp (modified) (1 diff)
• rendering/RenderListBox.h (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-11-03  Chris Lord  <clord@igalia.com>
+
+        [GTK][WPE] Use the display refresh to drive scrolling animations (sync scroll)
+        https://bugs.webkit.org/show_bug.cgi?id=232077
+
+        Reviewed by Simon Fraser.
+
+        Service sync scroll animations as part of the scroll phase in
+        Page::updateRendering, which is driven by the display refresh.
+
+        No new tests, covered by existing tests.
+
+        * dom/Document.cpp:
+        (WebCore::serviceScrollAnimationForScrollableArea):
+        (WebCore::Document::runScrollSteps):
+        * page/FrameView.cpp:
+        (WebCore::FrameView::didStartScrollAnimation):
+        * page/FrameView.h:
+        * platform/ScrollAnimator.cpp:
+        (WebCore::ScrollAnimator::ScrollAnimator):
+        (WebCore::ScrollAnimator::startAnimationCallback):
+        (WebCore::ScrollAnimator::stopAnimationCallback):
+        (WebCore::ScrollAnimator::serviceScrollAnimation):
+        (WebCore::ScrollAnimator::scrollControllerAnimationTimerFired): Deleted.
+        * platform/ScrollAnimator.h:
+        * platform/ScrollableArea.h:
+        (WebCore::ScrollableArea::didStartScrollAnimation):
+        * platform/ScrollingEffectsController.cpp:
+        (WebCore::ScrollingEffectsController::retargetAnimatedScrollBy):
+        * rendering/RenderLayerScrollableArea.cpp:
+        (WebCore::RenderLayerScrollableArea::didStartScrollAnimation):
+        * rendering/RenderLayerScrollableArea.h:
+        * rendering/RenderListBox.cpp:
+        (WebCore::RenderListBox::didStartScrollAnimation):
+        * rendering/RenderListBox.h:
+
 2021-11-03  Zalan Bujtas  <zalan@apple.com>
 

trunk/Source/WebCore/dom/Document.cpp

@@ -212 +212 @@
 #include "ScriptState.h"
 #include "ScriptedAnimationController.h"
+#include "ScrollAnimator.h"
 #include "ScrollbarTheme.h"
 #include "ScrollingCoordinator.h"
@@ -4348 +4349 @@
 }
 
+static bool serviceScrollAnimationForScrollableArea(ScrollableArea* scrollableArea, MonotonicTime time)
+{
+    if (!scrollableArea)
+        return false;
+
+    if (auto* animator = scrollableArea->existingScrollAnimator())
+        return animator->serviceScrollAnimation(time) == ScrollAnimationStatus::Animating;
+
+    return false;
+}
+
 // https://drafts.csswg.org/cssom-view/#run-the-scroll-steps
 void Document::runScrollSteps()
 {
+    // Service user scroll animations before scroll event dispatch.
+    RefPtr<FrameView> frameView = view();
+    if (frameView) {
+        MonotonicTime now = MonotonicTime::now();
+        bool scrollAnimationsInProgress = serviceScrollAnimationForScrollableArea(frameView.get(), now);
+        if (auto* scrollableAreas = frameView->scrollableAreas()) {
+            for (auto* scrollableArea : *scrollableAreas) {
+                if (serviceScrollAnimationForScrollableArea(scrollableArea, now))
+                    scrollAnimationsInProgress = true;
+            }
+        }
+        if (scrollAnimationsInProgress)
+            page()->scheduleRenderingUpdate({ RenderingUpdateStep::Scroll });
+    }
+
     // FIXME: The order of dispatching is not specified: https://github.com/WICG/visual-viewport/issues/66.
     if (m_pendingScrollEventTargetList && !m_pendingScrollEventTargetList->targets.isEmpty()) {

trunk/Source/WebCore/page/FrameView.cpp

@@ -5701 +5701 @@
 }
 
+void FrameView::didStartScrollAnimation()
+{
+    if (auto* page = frame().page())
+        page->scheduleRenderingUpdate({ RenderingUpdateStep::Scroll });
+}
+
 void FrameView::updateScrollbarSteps()
 {

trunk/Source/WebCore/page/FrameView.h

@@ -877 +877 @@
     // ScrollableArea.
     float pageScaleFactor() const override;
+    void didStartScrollAnimation() final;
 
     static MonotonicTime sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache

trunk/Source/WebCore/platform/ScrollAnimator.cpp

@@ -55 +55 @@
     : m_scrollableArea(scrollableArea)
     , m_scrollController(*this)
-    , m_scrollControllerAnimationTimer(*this, &ScrollAnimator::scrollControllerAnimationTimerFired)
     , m_keyboardScrollingAnimator(makeUnique<KeyboardScrollingAnimator>(*this, m_scrollController))
 {
@@ -385 +384 @@
 void ScrollAnimator::startAnimationCallback(ScrollingEffectsController&)
 {
-    if (m_scrollControllerAnimationTimer.isActive())
-        return;
-
-    m_scrollControllerAnimationTimer.startRepeating(1_s / 60.);
+    if (!m_scrollAnimationScheduled) {
+        m_scrollAnimationScheduled = true;
+        m_scrollableArea.didStartScrollAnimation();
+    }
 }
 
 void ScrollAnimator::stopAnimationCallback(ScrollingEffectsController&)
 {
-    m_scrollControllerAnimationTimer.stop();
-}
-
-void ScrollAnimator::scrollControllerAnimationTimerFired()
-{
-    m_scrollController.animationCallback(MonotonicTime::now());
+    m_scrollAnimationScheduled = false;
 }
 
@@ -466 +460 @@
 }
 
+ScrollAnimationStatus ScrollAnimator::serviceScrollAnimation(MonotonicTime time)
+{
+    if (m_scrollAnimationScheduled)
+        m_scrollController.animationCallback(time);
+    return m_scrollAnimationScheduled ? ScrollAnimationStatus::Animating : ScrollAnimationStatus::NotAnimating;
+}
+
 } // namespace WebCore

trunk/Source/WebCore/platform/ScrollAnimator.h

@@ -124 +124 @@
     void resnapAfterLayout();
 
+    ScrollAnimationStatus serviceScrollAnimation(MonotonicTime);
+
 protected:
     virtual bool platformAllowsScrollAnimation() const { return true; }
@@ -130 +132 @@
     void notifyPositionChanged(const FloatSize& delta);
 
-    void scrollControllerAnimationTimerFired();
     void updateActiveScrollSnapIndexForOffset();
 
@@ -177 +178 @@
     RefPtr<WheelEventTestMonitor> m_wheelEventTestMonitor;
     ScrollingEffectsController m_scrollController;
-    Timer m_scrollControllerAnimationTimer;
     FloatPoint m_currentPosition;
 
     std::unique_ptr<KeyboardScrollingAnimator> m_keyboardScrollingAnimator;
+
+private:
+    bool m_scrollAnimationScheduled { false };
 };
 

trunk/Source/WebCore/platform/ScrollableArea.h

@@ -354 +354 @@
     }
 
+    virtual void didStartScrollAnimation() { }
+
 protected:
     WEBCORE_EXPORT ScrollableArea();
@@ -414 +416 @@
     bool m_scrollOriginChanged { false };
     bool m_scrollShouldClearLatchedState { false };
+    bool m_hasActiveScrollAnimation { false };
 };
 

trunk/Source/WebCore/platform/ScrollingEffectsController.cpp

@@ -121 +121 @@
 bool ScrollingEffectsController::retargetAnimatedScrollBy(FloatSize offset)
 {
-    if (!is<ScrollAnimationSmooth>(m_currentAnimation.get()))
+    if (!is<ScrollAnimationSmooth>(m_currentAnimation.get()) || !m_currentAnimation->isActive())
         return false;
 
     LOG_WITH_STREAM(ScrollAnimations, stream << "ScrollingEffectsController " << this << " retargetAnimatedScrollBy " << offset);
 
-    ASSERT(m_currentAnimation->isActive());
     if (auto destinationOffset = m_currentAnimation->destinationOffset())
         return m_currentAnimation->retargetActiveAnimation(*destinationOffset + offset);

trunk/Source/WebCore/rendering/RenderLayerScrollableArea.cpp

@@ -1841 +1841 @@
 }
 
+void RenderLayerScrollableArea::didStartScrollAnimation()
+{
+    m_layer.page().scheduleRenderingUpdate({ RenderingUpdateStep::Scroll });
+}
+
 } // namespace WebCore

trunk/Source/WebCore/rendering/RenderLayerScrollableArea.h

@@ -195 +195 @@
 
     String debugDescription() const final;
+    void didStartScrollAnimation() final;
 
     IntSize visibleSize() const final;

trunk/Source/WebCore/rendering/RenderListBox.cpp

@@ -909 +909 @@
 }
 
+void RenderListBox::didStartScrollAnimation()
+{
+    page().scheduleRenderingUpdate({ RenderingUpdateStep::Scroll });
+}
+
 Ref<Scrollbar> RenderListBox::createScrollbar()
 {

trunk/Source/WebCore/rendering/RenderListBox.h

@@ -142 +142 @@
     void logMockScrollAnimatorMessage(const String&) const final;
     String debugDescription() const final;
+    void didStartScrollAnimation() final;
 
     // NOTE: This should only be called by the overridden setScrollOffset from ScrollableArea.