Bug 1531217 - Document origin rewrite and framebuffer coordinates r=gw,nical

The goal of this change was to simplify the semantics of our document placement and split the logical elements inside (display list) from the actual screen rectangle occupied by a document.
To achieve that, we introduce the framebuffer space for things Y-flipped on screen.
We fix the frame outputs, so that they get produced on the first frame without loopback from the frame building to scene building.

Differential Revision: https://phabricator.services.mozilla.com/D21641

[wrupdater] From https://hg.mozilla.org/mozilla-central/rev/ee88f4e35d4fd18ee954609185445c3fd7e1cecd

Author: kvark

direct-composition/src/main_windows.rs

@@ -8,6 +8,7 @@ extern crate gleam;
 extern crate webrender;
 extern crate winit;
 
+use euclid::size2;
 use direct_composition::DirectComposition;
 use std::sync::mpsc;
 use webrender::api;
@@ -34,10 +35,9 @@ fn main() {
 
     let mut clicks: usize = 0;
     let mut offset_y = 100.;
-    let size = api::DeviceIntSize::new;
     let mut rects = [
-        Rectangle::new(&composition, &notifier, factor, size(300, 200), 0., 0.2, 0.4, 1.),
-        Rectangle::new(&composition, &notifier, factor, size(400, 300), 0., 0.5, 0., 0.5),
+        Rectangle::new(&composition, &notifier, factor, size2(300, 200), 0., 0.2, 0.4, 1.),
+        Rectangle::new(&composition, &notifier, factor, size2(400, 300), 0., 0.5, 0., 0.5),
     ];
     rects[0].render(factor, &rx);
     rects[1].render(factor, &rx);
@@ -95,13 +95,13 @@ struct Rectangle {
     renderer: Option<webrender::Renderer>,
     api: api::RenderApi,
     document_id: api::DocumentId,
-    size: api::DeviceIntSize,
+    size: api::FramebufferIntSize,
     color: api::ColorF,
 }
 
 impl Rectangle {
     fn new(composition: &DirectComposition, notifier: &Box<Notifier>,
-           device_pixel_ratio: f32, size: api::DeviceIntSize, r: f32, g: f32, b: f32, a: f32)
+           device_pixel_ratio: f32, size: api::FramebufferIntSize, r: f32, g: f32, b: f32, a: f32)
            -> Self {
         let visual = composition.create_angle_visual(size.width as u32, size.height as u32);
         visual.make_current();

examples/alpha_perf.rs

@@ -25,7 +25,7 @@ impl Example for App {
         _api: &RenderApi,
         builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/animation.rs

@@ -106,7 +106,7 @@ impl Example for App {
         _api: &RenderApi,
         builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/basic.rs

@@ -185,7 +185,7 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        _: DeviceIntSize,
+        _: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/blob.rs

@@ -199,7 +199,7 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        _framebuffer_size: api::DeviceIntSize,
+        _framebuffer_size: api::FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/common/boilerplate.rs

@@ -79,7 +79,7 @@ pub trait Example {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        framebuffer_size: DeviceIntSize,
+        framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         document_id: DocumentId,
     );
@@ -164,7 +164,7 @@ pub fn main_wrapper<E: Example>(
             .get_inner_size()
             .unwrap()
             .to_physical(device_pixel_ratio as f64);
-        DeviceIntSize::new(size.width as i32, size.height as i32)
+        FramebufferIntSize::new(size.width as i32, size.height as i32)
     };
     let notifier = Box::new(Notifier::new(events_loop.create_proxy()));
     let (mut renderer, sender) = webrender::Renderer::new(gl.clone(), notifier, opts, None).unwrap();
@@ -212,18 +212,19 @@ pub fn main_wrapper<E: Example>(
         let mut custom_event = true;
 
         let old_flags = debug_flags;
-        match global_event {
-            winit::Event::WindowEvent {
-                event: winit::WindowEvent::CloseRequested,
-                ..
-            } => return winit::ControlFlow::Break,
-            winit::Event::WindowEvent {
-                event: winit::WindowEvent::KeyboardInput {
-                    input: winit::KeyboardInput {
-                        state: winit::ElementState::Pressed,
-                        virtual_keycode: Some(key),
-                        ..
-                    },
+        let win_event = match global_event {
+            winit::Event::WindowEvent { event, .. } => event,
+            _ => return winit::ControlFlow::Continue,
+        };
+        match win_event {
+            winit::WindowEvent::CloseRequested => return winit::ControlFlow::Break,
+            // skip high-frequency events
+            winit::WindowEvent::AxisMotion { .. } |
+            winit::WindowEvent::CursorMoved { .. } => return winit::ControlFlow::Continue,
+            winit::WindowEvent::KeyboardInput {
+                input: winit::KeyboardInput {
+                    state: winit::ElementState::Pressed,
+                    virtual_keycode: Some(key),
                     ..
                 },
                 ..
@@ -241,14 +242,12 @@ pub fn main_wrapper<E: Example>(
                     DebugFlags::NEW_FRAME_INDICATOR | DebugFlags::NEW_SCENE_INDICATOR
                 ),
                 winit::VirtualKeyCode::G => debug_flags.toggle(DebugFlags::GPU_CACHE_DBG),
-                winit::VirtualKeyCode::Key1 => txn.set_window_parameters(
-                    framebuffer_size,
-                    DeviceIntRect::new(DeviceIntPoint::zero(), framebuffer_size),
+                winit::VirtualKeyCode::Key1 => txn.set_document_view(
+                    framebuffer_size.into(),
                     1.0
                 ),
-                winit::VirtualKeyCode::Key2 => txn.set_window_parameters(
-                    framebuffer_size,
-                    DeviceIntRect::new(DeviceIntPoint::zero(), framebuffer_size),
+                winit::VirtualKeyCode::Key2 => txn.set_document_view(
+                    framebuffer_size.into(),
                     2.0
                 ),
                 winit::VirtualKeyCode::M => api.notify_memory_pressure(),
@@ -260,23 +259,18 @@ pub fn main_wrapper<E: Example>(
                     api.save_capture(path, bits);
                 },
                 _ => {
-                    let win_event = match global_event {
-                        winit::Event::WindowEvent { event, .. } => event,
-                        _ => unreachable!()
-                    };
                     custom_event = example.on_event(
                         win_event,
                         &api,
                         document_id,
                     )
                 },
             },
-            winit::Event::WindowEvent { event, .. } => custom_event = example.on_event(
-                event,
+            other => custom_event = example.on_event(
+                other,
                 &api,
                 document_id,
             ),
-            _ => return winit::ControlFlow::Continue,
         };
 
         if debug_flags != old_flags {

examples/document.rs

@@ -33,50 +33,52 @@ impl App {
     fn init(
         &mut self,
         api: &RenderApi,
-        framebuffer_size: DeviceIntSize,
         device_pixel_ratio: f32,
     ) {
         let init_data = vec![
             (
                 PipelineId(1, 0),
-                -1,
+                1,
                 ColorF::new(0.0, 1.0, 0.0, 1.0),
-                DeviceIntPoint::new(0, 0),
+                FramebufferIntPoint::new(0, 400),
             ),
             (
                 PipelineId(2, 0),
-                -2,
+                2,
                 ColorF::new(1.0, 1.0, 0.0, 1.0),
-                DeviceIntPoint::new(200, 0),
+                FramebufferIntPoint::new(200, 400),
             ),
             (
                 PipelineId(3, 0),
-                -3,
+                3,
                 ColorF::new(1.0, 0.0, 0.0, 1.0),
-                DeviceIntPoint::new(200, 200),
+                FramebufferIntPoint::new(200, 600),
             ),
             (
                 PipelineId(4, 0),
-                -4,
+                4,
                 ColorF::new(1.0, 0.0, 1.0, 1.0),
-                DeviceIntPoint::new(0, 200),
+                FramebufferIntPoint::new(0, 600),
             ),
         ];
 
         for (pipeline_id, layer, color, offset) in init_data {
-            let size = DeviceIntSize::new(250, 250);
-            let bounds = DeviceIntRect::new(offset, size);
+            let size = FramebufferIntSize::new(250, 250);
+            let bounds = FramebufferIntRect::new(offset, size);
 
             let document_id = api.add_document(size, layer);
             let mut txn = Transaction::new();
-            txn.set_window_parameters(framebuffer_size, bounds, device_pixel_ratio);
+            txn.set_document_view(bounds, device_pixel_ratio);
             txn.set_root_pipeline(pipeline_id);
             api.send_transaction(document_id, txn);
 
             self.documents.push(Document {
                 id: document_id,
                 pipeline_id,
-                content_rect: bounds.to_f32() / TypedScale::new(device_pixel_ratio),
+                content_rect: LayoutRect::new(
+                    LayoutPoint::origin(),
+                    bounds.size.to_f32() / TypedScale::new(device_pixel_ratio),
+                ),
                 color,
             });
         }
@@ -89,7 +91,7 @@ impl Example for App {
         api: &RenderApi,
         base_builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        framebuffer_size: DeviceIntSize,
+        framebuffer_size: FramebufferIntSize,
         _pipeline_id: PipelineId,
         _: DocumentId,
     ) {
@@ -98,7 +100,7 @@ impl Example for App {
                 base_builder.content_size().width;
             // this is the first run, hack around the boilerplate,
             // which assumes an example only needs one document
-            self.init(api, framebuffer_size, device_pixel_ratio);
+            self.init(api,  device_pixel_ratio);
         }
 
         for doc in &self.documents {

examples/frame_output.rs

@@ -42,8 +42,8 @@ struct ExternalHandler {
 }
 
 impl webrender::OutputImageHandler for OutputHandler {
-    fn lock(&mut self, _id: PipelineId) -> Option<(u32, DeviceIntSize)> {
-        Some((self.texture_id, DeviceIntSize::new(500, 500)))
+    fn lock(&mut self, _id: PipelineId) -> Option<(u32, FramebufferIntSize)> {
+        Some((self.texture_id, FramebufferIntSize::new(500, 500)))
     }
 
     fn unlock(&mut self, _id: PipelineId) {}
@@ -68,7 +68,7 @@ impl App {
     fn init_output_document(
         &mut self,
         api: &RenderApi,
-        framebuffer_size: DeviceIntSize,
+        framebuffer_size: FramebufferIntSize,
         device_pixel_ratio: f32,
     ) {
         // Generate the external image key that will be used to render the output document to the root document.
@@ -77,24 +77,29 @@ impl App {
         let pipeline_id = PipelineId(1, 0);
         let layer = 1;
         let color = ColorF::new(1., 1., 0., 1.);
-        let bounds = DeviceIntRect::new(DeviceIntPoint::zero(), framebuffer_size);
         let document_id = api.add_document(framebuffer_size, layer);
+        api.enable_frame_output(document_id, pipeline_id, true);
+        api.set_document_view(
+            document_id,
+            FramebufferIntRect::new(
+                FramebufferIntPoint::new(0, 1000),
+                framebuffer_size,
+            ),
+            device_pixel_ratio,
+        );
 
         let document = Document {
             id: document_id,
             pipeline_id,
-            content_rect: bounds.to_f32() / TypedScale::new(device_pixel_ratio),
+            content_rect: LayoutRect::new(
+                LayoutPoint::zero(),
+                framebuffer_size.to_f32() / TypedScale::new(device_pixel_ratio),
+            ),
             color,
         };
 
         let mut txn = Transaction::new();
 
-        txn.enable_frame_output(document.pipeline_id, true);
-
-        api.send_transaction(document.id, txn);
-
-        let mut txn = Transaction::new();
-
         txn.add_image(
             self.external_image_key.unwrap(),
             ImageDescriptor::new(100, 100, ImageFormat::BGRA8, true, false),
@@ -141,14 +146,14 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        framebuffer_size: DeviceIntSize,
+        framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {
         if self.output_document.is_none() {
             let device_pixel_ratio = framebuffer_size.width as f32 /
                 builder.content_size().width;
-            self.init_output_document(api, DeviceIntSize::new(200, 200), device_pixel_ratio);
+            self.init_output_document(api, FramebufferIntSize::new(200, 200), device_pixel_ratio);
         }
 
         let info = LayoutPrimitiveInfo::new((100, 100).to(200, 200));

examples/iframe.rs

@@ -25,7 +25,7 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         document_id: DocumentId,
     ) {

examples/image_resize.rs

@@ -25,7 +25,7 @@ impl Example for App {
         _api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/multiwindow.rs

@@ -103,7 +103,7 @@ impl Window {
                 .get_inner_size()
                 .unwrap()
                 .to_physical(device_pixel_ratio as f64);
-            DeviceIntSize::new(size.width as i32, size.height as i32)
+            FramebufferIntSize::new(size.width as i32, size.height as i32)
         };
         let notifier = Box::new(Notifier::new(events_loop.create_proxy()));
         let (renderer, sender) = webrender::Renderer::new(gl.clone(), notifier, opts, None).unwrap();
@@ -182,7 +182,7 @@ impl Window {
                 .get_inner_size()
                 .unwrap()
                 .to_physical(device_pixel_ratio as f64);
-            DeviceIntSize::new(size.width as i32, size.height as i32)
+            FramebufferIntSize::new(size.width as i32, size.height as i32)
         };
         let layout_size = framebuffer_size.to_f32() / euclid::TypedScale::new(device_pixel_ratio);
         let mut txn = Transaction::new();

examples/scrolling.rs

@@ -26,7 +26,7 @@ impl Example for App {
         _api: &RenderApi,
         builder: &mut DisplayListBuilder,
         _txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/texture_cache_stress.rs

@@ -90,7 +90,7 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {

examples/yuv.rs

@@ -87,7 +87,7 @@ impl Example for App {
         api: &RenderApi,
         builder: &mut DisplayListBuilder,
         txn: &mut Transaction,
-        _framebuffer_size: DeviceIntSize,
+        _framebuffer_size: FramebufferIntSize,
         pipeline_id: PipelineId,
         _document_id: DocumentId,
     ) {