Merge pull request #64 from rust-windowing/display-window-split

Split display/window wrappers

Author: ids1024

README.md

@@ -53,15 +53,15 @@ For now, the priority for new platforms is:
 Example
 ==
 ```rust,no_run
-use softbuffer::GraphicsContext;
 use winit::event::{Event, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
 use winit::window::WindowBuilder;
 
 fn main() {
     let event_loop = EventLoop::new();
     let window = WindowBuilder::new().build(&event_loop).unwrap();
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     event_loop.run(move |event, _, control_flow| {
         *control_flow = ControlFlow::Wait;
@@ -86,7 +86,7 @@ fn main() {
                     })
                     .collect::<Vec<_>>();
 
-                graphics_context.set_buffer(&buffer, width as u16, height as u16);
+                surface.set_buffer(&buffer, width as u16, height as u16);
             }
             Event::WindowEvent {
                 event: WindowEvent::CloseRequested,

examples/animation.rs

@@ -1,7 +1,6 @@
 use instant::Instant;
 #[cfg(not(target_arch = "wasm32"))]
 use rayon::prelude::*;
-use softbuffer::GraphicsContext;
 use std::f64::consts::PI;
 use winit::event::{Event, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
@@ -25,7 +24,8 @@ fn main() {
             .unwrap();
     }
 
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     let mut old_size = (0, 0);
     let mut frames = pre_render_frames(0, 0);
@@ -48,7 +48,7 @@ fn main() {
                 };
 
                 let buffer = &frames[((elapsed * 60.0).round() as usize).clamp(0, 59)];
-                graphics_context.set_buffer(buffer.as_slice(), width as u16, height as u16);
+                surface.set_buffer(buffer.as_slice(), width as u16, height as u16);
             }
             Event::MainEventsCleared => {
                 window.request_redraw();

examples/fruit.rs

@@ -1,5 +1,4 @@
 use image::GenericImageView;
-use softbuffer::GraphicsContext;
 use winit::event::{Event, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
 use winit::window::WindowBuilder;
@@ -38,14 +37,15 @@ fn main() {
             .unwrap();
     }
 
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     event_loop.run(move |event, _, control_flow| {
         *control_flow = ControlFlow::Wait;
 
         match event {
             Event::RedrawRequested(window_id) if window_id == window.id() => {
-                graphics_context.set_buffer(&buffer, fruit.width() as u16, fruit.height() as u16);
+                surface.set_buffer(&buffer, fruit.width() as u16, fruit.height() as u16);
             }
             Event::WindowEvent {
                 event: WindowEvent::CloseRequested,

examples/libxcb.rs

@@ -3,7 +3,6 @@
 #[cfg(all(feature = "x11", any(target_os = "linux", target_os = "freebsd")))]
 mod example {
     use raw_window_handle::{RawDisplayHandle, RawWindowHandle, XcbDisplayHandle, XcbWindowHandle};
-    use softbuffer::GraphicsContext;
     use x11rb::{
         connection::Connection,
         protocol::{
@@ -54,13 +53,12 @@ mod example {
 
         // Create a new softbuffer context.
         // SAFETY: The display and window handles outlive the context.
-        let mut context = unsafe {
-            GraphicsContext::from_raw(
-                RawWindowHandle::Xcb(window_handle),
-                RawDisplayHandle::Xcb(display_handle),
-            )
-        }
-        .unwrap();
+        let context =
+            unsafe { softbuffer::Context::from_raw(RawDisplayHandle::Xcb(display_handle)) }
+                .unwrap();
+        let mut surface =
+            unsafe { softbuffer::Surface::from_raw(&context, RawWindowHandle::Xcb(window_handle)) }
+                .unwrap();
 
         // Register an atom for closing the window.
         let wm_protocols_atom = conn
@@ -104,7 +102,7 @@ mod example {
                         .collect::<Vec<_>>();
 
                     // Draw the buffer.
-                    context.set_buffer(&source, width, height);
+                    surface.set_buffer(&source, width, height);
                 }
                 Event::ConfigureNotify(configure_notify) => {
                     width = configure_notify.width;

examples/rectangle.rs

@@ -1,4 +1,3 @@
-use softbuffer::GraphicsContext;
 use winit::event::{ElementState, Event, KeyboardInput, VirtualKeyCode, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
 use winit::window::WindowBuilder;
@@ -41,7 +40,8 @@ fn main() {
             .unwrap();
     }
 
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     let mut buffer = Vec::new();
     let mut flag = false;
@@ -66,7 +66,7 @@ fn main() {
                 redraw(&mut buffer, width, height, flag);
 
                 // Blit the offscreen buffer to the window's client area
-                graphics_context.set_buffer(&buffer, width as u16, height as u16);
+                surface.set_buffer(&buffer, width as u16, height as u16);
             }
 
             Event::WindowEvent {

examples/winit.rs

@@ -1,4 +1,3 @@
-use softbuffer::GraphicsContext;
 use winit::event::{Event, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
 use winit::window::WindowBuilder;
@@ -21,7 +20,8 @@ fn main() {
             .unwrap();
     }
 
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     event_loop.run(move |event, _, control_flow| {
         *control_flow = ControlFlow::Wait;
@@ -46,7 +46,7 @@ fn main() {
                     })
                     .collect::<Vec<_>>();
 
-                graphics_context.set_buffer(&buffer, width as u16, height as u16);
+                surface.set_buffer(&buffer, width as u16, height as u16);
             }
             Event::WindowEvent {
                 event: WindowEvent::CloseRequested,

examples/winit_wrong_sized_buffer.rs

@@ -1,4 +1,3 @@
-use softbuffer::GraphicsContext;
 use winit::event::{Event, WindowEvent};
 use winit::event_loop::{ControlFlow, EventLoop};
 use winit::window::WindowBuilder;
@@ -24,7 +23,8 @@ fn main() {
             .unwrap();
     }
 
-    let mut graphics_context = unsafe { GraphicsContext::new(&window, &window) }.unwrap();
+    let context = unsafe { softbuffer::Context::new(&window) }.unwrap();
+    let mut surface = unsafe { softbuffer::Surface::new(&context, &window) }.unwrap();
 
     event_loop.run(move |event, _, control_flow| {
         *control_flow = ControlFlow::Wait;
@@ -45,7 +45,7 @@ fn main() {
                     })
                     .collect::<Vec<_>>();
 
-                graphics_context.set_buffer(&buffer, BUFFER_WIDTH as u16, BUFFER_HEIGHT as u16);
+                surface.set_buffer(&buffer, BUFFER_WIDTH as u16, BUFFER_HEIGHT as u16);
             }
             Event::WindowEvent {
                 event: WindowEvent::CloseRequested,

src/error.rs

@@ -5,14 +5,20 @@ use thiserror::Error;
 #[derive(Error, Debug)]
 #[non_exhaustive]
 pub enum SoftBufferError {
+    #[error(
+        "The provided display returned an unsupported platform: {human_readable_display_platform_name}."
+    )]
+    UnsupportedDisplayPlatform {
+        human_readable_display_platform_name: &'static str,
+        display_handle: RawDisplayHandle,
+    },
     #[error(
         "The provided window returned an unsupported platform: {human_readable_window_platform_name}, {human_readable_display_platform_name}."
     )]
-    UnsupportedPlatform {
+    UnsupportedWindowPlatform {
         human_readable_window_platform_name: &'static str,
         human_readable_display_platform_name: &'static str,
         window_handle: RawWindowHandle,
-        display_handle: RawDisplayHandle,
     },
 
     #[error("The provided window handle is null.")]