Allow building examples using softbuffer on Android

Cargo.toml

@@ -39,7 +39,7 @@ tracing = { version = "0.1.40", default-features = false }
 
 # Dev dependencies.
 image = { version = "0.25.0", default-features = false }
-softbuffer = { version = "0.4.6", default-features = false, features = [
+softbuffer = { version = "0.4.8", default-features = false, features = [
     "x11",
     "x11-dlopen",
     "wayland",

winit/Cargo.toml

@@ -76,12 +76,10 @@ winit-core.workspace = true
 
 [dev-dependencies]
 image = { workspace = true, features = ["png"] }
+softbuffer.workspace = true
 tracing = { workspace = true, features = ["log"] }
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
 
-[target.'cfg(not(target_os = "android"))'.dev-dependencies]
-softbuffer.workspace = true
-
 [target.'cfg(target_os = "android")'.dependencies]
 winit-android.workspace = true
 

winit/examples/application.rs

@@ -7,21 +7,18 @@ use std::borrow::Cow;
 use std::collections::HashMap;
 use std::error::Error;
 use std::fmt::Debug;
-#[cfg(not(android_platform))]
 use std::num::NonZeroU32;
 use std::sync::Arc;
 use std::sync::mpsc::{self, Receiver, Sender};
-#[cfg(all(not(android_platform), not(web_platform)))]
+#[cfg(not(web_platform))]
 use std::time::Instant;
 use std::{fmt, mem};
 
 use cursor_icon::CursorIcon;
-#[cfg(not(android_platform))]
 use rwh_06::{DisplayHandle, HasDisplayHandle};
-#[cfg(not(android_platform))]
 use softbuffer::{Context, Surface};
 use tracing::{error, info};
-#[cfg(all(web_platform, not(android_platform)))]
+#[cfg(web_platform)]
 use web_time::Instant;
 use winit::application::ApplicationHandler;
 use winit::cursor::{Cursor, CustomCursor, CustomCursorSource};
@@ -97,14 +94,12 @@ struct Application {
     /// Drawing context.
     ///
     /// With OpenGL it could be EGLDisplay.
-    #[cfg(not(android_platform))]
     context: Option<Context<DisplayHandle<'static>>>,
 }
 
 impl Application {
     fn new(event_loop: &EventLoop, receiver: Receiver<Action>, sender: Sender<Action>) -> Self {
         // SAFETY: we drop the context right before the event loop is stopped, thus making it safe.
-        #[cfg(not(android_platform))]
         let context = Some(
             Context::new(unsafe {
                 std::mem::transmute::<DisplayHandle<'_>, DisplayHandle<'static>>(
@@ -130,15 +125,7 @@ impl Application {
         .into_iter()
         .collect();
 
-        Self {
-            receiver,
-            sender,
-            #[cfg(not(android_platform))]
-            context,
-            custom_cursors,
-            icon,
-            windows: Default::default(),
-        }
+        Self { receiver, sender, context, custom_cursors, icon, windows: Default::default() }
     }
 
     fn create_window(
@@ -620,7 +607,6 @@ struct WindowState {
     /// Render surface.
     ///
     /// NOTE: This surface must be dropped before the `Window`.
-    #[cfg(not(android_platform))]
     surface: Surface<DisplayHandle<'static>, Arc<dyn Window>>,
     /// The actual winit Window.
     window: Arc<dyn Window>,
@@ -629,7 +615,6 @@ struct WindowState {
     /// Fill the window with animated color
     animated_fill_color: bool,
     /// The application start time. Used for color fill animation
-    #[cfg(not(android_platform))]
     start_time: Instant,
     /// Redraw continuously
     continuous_redraw: bool,
@@ -665,7 +650,6 @@ impl WindowState {
 
         // SAFETY: the surface is dropped before the `window` which provided it with handle, thus
         // it doesn't outlive it.
-        #[cfg(not(android_platform))]
         let surface = Surface::new(app.context.as_ref().unwrap(), Arc::clone(&window))?;
 
         let theme = window.theme().unwrap_or(Theme::Dark);
@@ -680,14 +664,12 @@ impl WindowState {
             custom_idx: app.custom_cursors.as_ref().map(Vec::len).unwrap_or(1) - 1,
             cursor_grab: CursorGrabMode::None,
             named_idx,
-            #[cfg(not(android_platform))]
             surface,
             window,
             theme,
             animated_fill_color: false,
             continuous_redraw: false,
             emit_surface_size: false,
-            #[cfg(not(android_platform))]
             start_time: Instant::now(),
             cursor_position: Default::default(),
             cursor_hidden: Default::default(),
@@ -859,15 +841,12 @@ impl WindowState {
     /// Resize the surface to the new size.
     fn resize(&mut self, size: PhysicalSize<u32>) {
         info!("Surface resized to {size:?}");
-        #[cfg(not(android_platform))]
-        {
-            let (width, height) = match (NonZeroU32::new(size.width), NonZeroU32::new(size.height))
-            {
-                (Some(width), Some(height)) => (width, height),
-                _ => return,
-            };
-            self.surface.resize(width, height).expect("failed to resize inner buffer");
-        }
+        let (width, height) = match (NonZeroU32::new(size.width), NonZeroU32::new(size.height)) {
+            (Some(width), Some(height)) => (width, height),
+            _ => return,
+        };
+        self.surface.resize(width, height).expect("failed to resize inner buffer");
+
         self.window.request_redraw();
     }
 
@@ -952,7 +931,6 @@ impl WindowState {
     }
 
     /// Draw the window contents.
-    #[cfg(not(android_platform))]
     fn draw(&mut self) -> Result<(), Box<dyn Error>> {
         if self.occluded {
             info!("Skipping drawing occluded window={:?}", self.window.id());
@@ -998,12 +976,6 @@ impl WindowState {
 
         Ok(())
     }
-
-    #[cfg(android_platform)]
-    fn draw(&mut self) -> Result<(), Box<dyn Error>> {
-        info!("Drawing but without rendering...");
-        Ok(())
-    }
 }
 
 struct Binding<T: Eq> {

winit/examples/util/fill.rs

@@ -7,150 +7,109 @@
 //! The `softbuffer` crate is used, largely because of its ease of use. `glutin` or `wgpu` could
 //! also be used to fill the window buffer, but they are more complicated to use.
 
-#[allow(unused_imports)]
-pub use platform::cleanup_window;
-#[allow(unused_imports)]
-pub use platform::fill_window;
-#[allow(unused_imports)]
-pub use platform::fill_window_with_animated_color;
-#[allow(unused_imports)]
-pub use platform::fill_window_with_color;
-
-#[cfg(not(any(target_os = "android", target_os = "ios")))]
-mod platform {
-    use std::cell::RefCell;
-    use std::collections::HashMap;
-    use std::mem;
-    use std::mem::ManuallyDrop;
-    use std::num::NonZeroU32;
-    #[cfg(all(not(android_platform), not(web_platform)))]
-    use std::time::Instant;
-
-    use softbuffer::{Context, Surface};
-    #[cfg(all(web_platform, not(android_platform)))]
-    use web_time::Instant;
-    use winit::window::{Window, WindowId};
-
-    thread_local! {
-        // NOTE: You should never do things like that, create context and drop it before
-        // you drop the event loop. We do this for brevity to not blow up examples. We use
-        // ManuallyDrop to prevent destructors from running.
-        //
-        // A static, thread-local map of graphics contexts to open windows.
-        static GC: ManuallyDrop<RefCell<Option<GraphicsContext>>> = const { ManuallyDrop::new(RefCell::new(None)) };
-    }
+use std::cell::RefCell;
+use std::collections::HashMap;
+use std::mem;
+use std::mem::ManuallyDrop;
+use std::num::NonZeroU32;
+#[cfg(not(web_platform))]
+use std::time::Instant;
+
+use softbuffer::{Context, Surface};
+#[cfg(web_platform)]
+use web_time::Instant;
+use winit::window::{Window, WindowId};
+
+thread_local! {
+    // NOTE: You should never do things like that, create context and drop it before
+    // you drop the event loop. We do this for brevity to not blow up examples. We use
+    // ManuallyDrop to prevent destructors from running.
+    //
+    // A static, thread-local map of graphics contexts to open windows.
+    static GC: ManuallyDrop<RefCell<Option<GraphicsContext>>> = const { ManuallyDrop::new(RefCell::new(None)) };
+}
 
-    /// The graphics context used to draw to a window.
-    struct GraphicsContext {
-        /// The global softbuffer context.
-        context: RefCell<Context<&'static dyn Window>>,
+/// The graphics context used to draw to a window.
+struct GraphicsContext {
+    /// The global softbuffer context.
+    context: RefCell<Context<&'static dyn Window>>,
 
-        /// The hash map of window IDs to surfaces.
-        surfaces: HashMap<WindowId, Surface<&'static dyn Window, &'static dyn Window>>,
-    }
+    /// The hash map of window IDs to surfaces.
+    surfaces: HashMap<WindowId, Surface<&'static dyn Window, &'static dyn Window>>,
+}
 
-    impl GraphicsContext {
-        fn new(w: &dyn Window) -> Self {
-            Self {
-                context: RefCell::new(
-                    Context::new(unsafe {
-                        mem::transmute::<&'_ dyn Window, &'static dyn Window>(w)
-                    })
+impl GraphicsContext {
+    fn new(w: &dyn Window) -> Self {
+        Self {
+            context: RefCell::new(
+                Context::new(unsafe { mem::transmute::<&'_ dyn Window, &'static dyn Window>(w) })
                     .expect("Failed to create a softbuffer context"),
-                ),
-                surfaces: HashMap::new(),
-            }
+            ),
+            surfaces: HashMap::new(),
         }
+    }
 
-        fn create_surface(
-            &mut self,
-            window: &dyn Window,
-        ) -> &mut Surface<&'static dyn Window, &'static dyn Window> {
-            self.surfaces.entry(window.id()).or_insert_with(|| {
-                Surface::new(&self.context.borrow(), unsafe {
-                    mem::transmute::<&'_ dyn Window, &'static dyn Window>(window)
-                })
-                .expect("Failed to create a softbuffer surface")
+    fn create_surface(
+        &mut self,
+        window: &dyn Window,
+    ) -> &mut Surface<&'static dyn Window, &'static dyn Window> {
+        self.surfaces.entry(window.id()).or_insert_with(|| {
+            Surface::new(&self.context.borrow(), unsafe {
+                mem::transmute::<&'_ dyn Window, &'static dyn Window>(window)
             })
-        }
-
-        fn destroy_surface(&mut self, window: &dyn Window) {
-            self.surfaces.remove(&window.id());
-        }
+            .expect("Failed to create a softbuffer surface")
+        })
     }
 
-    pub fn fill_window_with_color(window: &dyn Window, color: u32) {
-        GC.with(|gc| {
-            let size = window.surface_size();
-            let (Some(width), Some(height)) =
-                (NonZeroU32::new(size.width), NonZeroU32::new(size.height))
-            else {
-                return;
-            };
-
-            // Either get the last context used or create a new one.
-            let mut gc = gc.borrow_mut();
-            let surface =
-                gc.get_or_insert_with(|| GraphicsContext::new(window)).create_surface(window);
-
-            // Fill a buffer with a solid color
+    fn destroy_surface(&mut self, window: &dyn Window) {
+        self.surfaces.remove(&window.id());
+    }
+}
 
-            surface.resize(width, height).expect("Failed to resize the softbuffer surface");
+pub fn fill_window_with_color(window: &dyn Window, color: u32) {
+    GC.with(|gc| {
+        let size = window.surface_size();
+        let (Some(width), Some(height)) =
+            (NonZeroU32::new(size.width), NonZeroU32::new(size.height))
+        else {
+            return;
+        };
 
-            let mut buffer = surface.buffer_mut().expect("Failed to get the softbuffer buffer");
-            buffer.fill(color);
-            buffer.present().expect("Failed to present the softbuffer buffer");
-        })
-    }
+        // Either get the last context used or create a new one.
+        let mut gc = gc.borrow_mut();
+        let surface = gc.get_or_insert_with(|| GraphicsContext::new(window)).create_surface(window);
 
-    #[allow(dead_code)]
-    pub fn fill_window(window: &dyn Window) {
-        fill_window_with_color(window, 0xff181818);
-    }
+        // Fill a buffer with a solid color
 
-    #[allow(dead_code)]
-    pub fn fill_window_with_animated_color(window: &dyn Window, start: Instant) {
-        let time = start.elapsed().as_secs_f32() * 1.5;
-        let blue = (time.sin() * 255.0) as u32;
-        let green = ((time.cos() * 255.0) as u32) << 8;
-        let red = ((1.0 - time.sin() * 255.0) as u32) << 16;
-        let color = red | green | blue;
-        fill_window_with_color(window, color);
-    }
+        surface.resize(width, height).expect("Failed to resize the softbuffer surface");
 
-    #[allow(dead_code)]
-    pub fn cleanup_window(window: &dyn Window) {
-        GC.with(|gc| {
-            let mut gc = gc.borrow_mut();
-            if let Some(context) = gc.as_mut() {
-                context.destroy_surface(window);
-            }
-        });
-    }
+        let mut buffer = surface.buffer_mut().expect("Failed to get the softbuffer buffer");
+        buffer.fill(color);
+        buffer.present().expect("Failed to present the softbuffer buffer");
+    })
 }
 
-#[cfg(any(target_os = "android", target_os = "ios"))]
-mod platform {
-    #[allow(dead_code)]
-    pub fn fill_window(_window: &dyn winit::window::Window) {
-        // No-op on mobile platforms.
-    }
-
-    #[allow(dead_code)]
-    pub fn fill_window_with_color(_window: &dyn winit::window::Window, _color: u32) {
-        // No-op on mobile platforms.
-    }
+#[allow(dead_code)]
+pub fn fill_window(window: &dyn Window) {
+    fill_window_with_color(window, 0xff181818);
+}
 
-    #[allow(dead_code)]
-    pub fn fill_window_with_animated_color(
-        _window: &dyn winit::window::Window,
-        _start: std::time::Instant,
-    ) {
-        // No-op on mobile platforms.
-    }
+#[allow(dead_code)]
+pub fn fill_window_with_animated_color(window: &dyn Window, start: Instant) {
+    let time = start.elapsed().as_secs_f32() * 1.5;
+    let blue = (time.sin() * 255.0) as u32;
+    let green = ((time.cos() * 255.0) as u32) << 8;
+    let red = ((1.0 - time.sin() * 255.0) as u32) << 16;
+    let color = red | green | blue;
+    fill_window_with_color(window, color);
+}
 
-    #[allow(dead_code)]
-    pub fn cleanup_window(_window: &dyn winit::window::Window) {
-        // No-op on mobile platforms.
-    }
+#[allow(dead_code)]
+pub fn cleanup_window(window: &dyn Window) {
+    GC.with(|gc| {
+        let mut gc = gc.borrow_mut();
+        if let Some(context) = gc.as_mut() {
+            context.destroy_surface(window);
+        }
+    });
 }