Add API for scrolling individual layers

This will allow Servo to reimplement scroll_to_fragment.

Author: mrobinson

webrender/src/frame.rs

@@ -21,7 +21,7 @@ use webrender_traits::{AuxiliaryLists, PipelineId, Epoch, ScrollPolicy, ScrollLa
 use webrender_traits::{ClipRegion, ColorF, DisplayItem, StackingContext, FilterOp, MixBlendMode};
 use webrender_traits::{ScrollEventPhase, ScrollLayerInfo, SpecificDisplayItem, ScrollLayerState};
 use webrender_traits::{LayerRect, LayerPoint, LayerSize};
-use webrender_traits::{ScrollLayerRect, as_scroll_parent_rect, ScrollLayerPixel};
+use webrender_traits::{ServoScrollRootId, ScrollLayerRect, as_scroll_parent_rect, ScrollLayerPixel};
 use webrender_traits::WorldPoint4D;
 use webrender_traits::{LayerTransform, LayerToScrollTransform, ScrollToWorldTransform};
 
@@ -52,6 +52,7 @@ pub struct Frame {
                                           AuxiliaryLists,
                                           BuildHasherDefault<FnvHasher>>,
     pub root_scroll_layer_id: Option<ScrollLayerId>,
+    pending_scroll_offsets: HashMap<PipelineId, HashMap<ServoScrollRootId, LayerPoint>>,
     id: FrameId,
     debug: bool,
     frame_builder_config: FrameBuilderConfig,
@@ -210,6 +211,7 @@ impl Frame {
             pipeline_auxiliary_lists: HashMap::with_hasher(Default::default()),
             layers: HashMap::with_hasher(Default::default()),
             root_scroll_layer_id: None,
+            pending_scroll_offsets: HashMap::new(),
             id: FrameId(0),
             debug: debug,
             frame_builder: None,
@@ -295,6 +297,40 @@ impl Frame {
         result
     }
 
+    /// Returns true if any layers actually changed position or false otherwise.
+    pub fn scroll_layers(&mut self,
+                         origin: Point2D<f32>,
+                         pipeline_id: PipelineId,
+                         scroll_root_id: ServoScrollRootId)
+                          -> bool {
+        let origin = LayerPoint::new(origin.x.max(0.0), origin.y.max(0.0));
+
+        let mut scrolled_a_layer = false;
+        let mut found_layer = false;
+        for (layer_id, layer) in self.layers.iter_mut() {
+            if layer_id.pipeline_id != pipeline_id {
+                continue;
+            }
+
+            match layer_id.info {
+                ScrollLayerInfo::Scrollable(_, id) if id != scroll_root_id => continue,
+                ScrollLayerInfo::Fixed => continue,
+                _ => {}
+            }
+
+            found_layer = true;
+            scrolled_a_layer |= layer.set_scroll_origin(&origin);
+        }
+
+        if !found_layer {
+            let scroll_offsets =
+                self.pending_scroll_offsets.entry(pipeline_id).or_insert_with(HashMap::new);
+            scroll_offsets.insert(scroll_root_id, origin);
+        }
+
+        scrolled_a_layer
+    }
+
     /// Returns true if any layers actually changed position or false otherwise.
     pub fn scroll(&mut self,
                   mut delta: Point2D<f32>,
@@ -480,6 +516,19 @@ impl Frame {
             };
 
             layer.finalize(&scrolling_state);
+
+            let scroll_root_id = match scroll_layer_id.info {
+                ScrollLayerInfo::Scrollable(_, scroll_root_id) => scroll_root_id,
+                _ => continue,
+            };
+
+
+            let pipeline_id = scroll_layer_id.pipeline_id;
+            if let Some(pending_offsets) = self.pending_scroll_offsets.get_mut(&pipeline_id) {
+                if let Some(ref offset) = pending_offsets.remove(&scroll_root_id) {
+                    layer.set_scroll_origin(offset);
+                }
+            }
         }
     }
 

webrender/src/layer.rs

@@ -86,6 +86,26 @@ impl Layer {
         LayerSize::new(overscroll_x, overscroll_y)
     }
 
+    pub fn set_scroll_origin(&mut self, origin: &LayerPoint) -> bool{
+        if self.content_size.width <= self.local_viewport_rect.size.width &&
+           self.content_size.height <= self.local_viewport_rect.size.height {
+            return false;
+        }
+
+        let new_offset = LayerPoint::new(
+            (-origin.x).max(-self.content_size.width + self.local_viewport_rect.size.width),
+            (-origin.y).max(-self.content_size.height + self.local_viewport_rect.size.height));
+        let new_offset = LayerPoint::new(new_offset.x.min(0.0).round(), new_offset.y.min(0.0).round());
+        if new_offset == self.scrolling.offset {
+            return false;
+        }
+
+        self.scrolling.offset = new_offset;
+        self.scrolling.bouncing_back = false;
+        self.scrolling.started_bouncing_back = false;
+        return true;
+    }
+
     pub fn stretch_overscroll_spring(&mut self) {
         let overscroll_amount = self.overscroll_amount();
         self.scrolling.spring.coords(self.scrolling.offset,

webrender/src/render_backend.rs

@@ -246,6 +246,24 @@ impl RenderBackend {
                                 None => self.notify_compositor_of_new_scroll_frame(false),
                             }
                         }
+                        ApiMsg::ScrollLayersWithScrollId(origin, pipeline_id, scroll_root_id) => {
+                            let frame = profile_counters.total_time.profile(|| {
+                                if self.frame.scroll_layers(origin, pipeline_id, scroll_root_id) {
+                                    Some(self.render())
+                                } else {
+                                    None
+                                }
+                            });
+
+                            match frame {
+                                Some(frame) => {
+                                    self.publish_frame(frame, &mut profile_counters);
+                                    self.notify_compositor_of_new_scroll_frame(true)
+                                }
+                                None => self.notify_compositor_of_new_scroll_frame(false),
+                            }
+
+                        }
                         ApiMsg::TickScrollingBounce => {
                             let frame = profile_counters.total_time.profile(|| {
                                 self.frame.tick_scrolling_bounce_animations();

webrender_traits/src/api.rs

@@ -9,7 +9,7 @@ use offscreen_gl_context::{GLContextAttributes, GLLimits};
 use std::cell::Cell;
 use {ApiMsg, AuxiliaryLists, BuiltDisplayList, ColorF, Epoch};
 use {FontKey, IdNamespace, ImageFormat, ImageKey, NativeFontHandle, PipelineId};
-use {RenderApiSender, ResourceId, ScrollEventPhase, ScrollLayerState};
+use {RenderApiSender, ResourceId, ScrollEventPhase, ScrollLayerState, ServoScrollRootId};
 use {GlyphKey, GlyphDimensions, ImageData, WebGLContextId, WebGLCommand};
 
 impl RenderApiSender {
@@ -193,6 +193,14 @@ impl RenderApi {
         self.api_sender.send(msg).unwrap();
     }
 
+    pub fn scroll_layers_with_scroll_root_id(&self,
+                                             new_scroll_origin: Point2D<f32>,
+                                             pipeline_id: PipelineId,
+                                             scroll_root_id: ServoScrollRootId) {
+        let msg = ApiMsg::ScrollLayersWithScrollId(new_scroll_origin, pipeline_id, scroll_root_id);
+        self.api_sender.send(msg).unwrap();
+    }
+
     pub fn tick_scrolling_bounce_animations(&self) {
         let msg = ApiMsg::TickScrollingBounce;
         self.api_sender.send(msg).unwrap();

webrender_traits/src/types.rs

@@ -49,6 +49,7 @@ pub enum ApiMsg {
                        AuxiliaryListsDescriptor),
     SetRootPipeline(PipelineId),
     Scroll(Point2D<f32>, Point2D<f32>, ScrollEventPhase),
+    ScrollLayersWithScrollId(Point2D<f32>, PipelineId, ServoScrollRootId),
     TickScrollingBounce,
     TranslatePointToLayerSpace(Point2D<f32>, MsgSender<(Point2D<f32>, PipelineId)>),
     GetScrollLayerState(MsgSender<Vec<ScrollLayerState>>),
@@ -449,6 +450,13 @@ impl ScrollLayerId {
             info: ScrollLayerInfo::Scrollable(0, ServoScrollRootId(0)),
         }
     }
+
+    pub fn scroll_root_id(&self) -> Option<ServoScrollRootId> {
+        match self.info {
+            ScrollLayerInfo::Scrollable(_, scroll_root_id) => Some(scroll_root_id),
+            ScrollLayerInfo::Fixed => None,
+        }
+    }
 }
 
 #[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]