From db00a67c609a6262eeba00b628d148631ebd0524 Mon Sep 17 00:00:00 2001
From: Jay Oster <jay@kodewerx.org>
Date: Sat, 4 Sep 2021 09:00:25 -0700
Subject: [PATCH] Add user-defined errors for render functions (#196)

- Fixes #189
---
 examples/custom-shader/src/main.rs |  2 ++
 examples/egui-winit/src/main.rs    |  5 +++--
 examples/imgui-winit/src/main.rs   |  5 +++--
 src/lib.rs                         | 27 +++++++++++++++++++++------
 4 files changed, 29 insertions(+), 10 deletions(-)

diff --git a/examples/custom-shader/src/main.rs b/examples/custom-shader/src/main.rs
index 8a88801..12938e5 100644
--- a/examples/custom-shader/src/main.rs
+++ b/examples/custom-shader/src/main.rs
@@ -60,6 +60,8 @@ fn main() -> Result<(), Error> {
                 time += 0.01;
 
                 noise_renderer.render(encoder, render_target, context.scaling_renderer.clip_rect());
+
+                Ok(())
             });
 
             if render_result
diff --git a/examples/egui-winit/src/main.rs b/examples/egui-winit/src/main.rs
index bc5e8a0..8223428 100644
--- a/examples/egui-winit/src/main.rs
+++ b/examples/egui-winit/src/main.rs
@@ -67,8 +67,9 @@ fn main() -> Result<(), Error> {
                 context.scaling_renderer.render(encoder, render_target);
 
                 // Render egui
-                gui.render(encoder, render_target, context)
-                    .expect("egui render error");
+                gui.render(encoder, render_target, context)?;
+
+                Ok(())
             });
 
             // Basic error handling
diff --git a/examples/imgui-winit/src/main.rs b/examples/imgui-winit/src/main.rs
index 52cacd5..9131595 100644
--- a/examples/imgui-winit/src/main.rs
+++ b/examples/imgui-winit/src/main.rs
@@ -70,8 +70,9 @@ fn main() -> Result<(), Error> {
                 context.scaling_renderer.render(encoder, render_target);
 
                 // Render Dear ImGui
-                gui.render(&window, encoder, render_target, context)
-                    .expect("gui.render() failed");
+                gui.render(&window, encoder, render_target, context)?;
+
+                Ok(())
             });
 
             // Basic error handling
diff --git a/src/lib.rs b/src/lib.rs
index cb3dd15..3d2e49e 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -115,6 +115,9 @@ pub enum Error {
     /// Equivalent to [`wgpu::SurfaceError`]
     #[error("The GPU failed to acquire a surface frame.")]
     Surface(wgpu::SurfaceError),
+    /// User-defined error from custom render function
+    #[error("User-defined error.")]
+    UserDefined(#[from] Box<dyn std::error::Error>),
 }
 
 impl<'win, W: HasRawWindowHandle> SurfaceTexture<'win, W> {
@@ -296,12 +299,14 @@ impl Pixels {
     /// }
     ///
     /// // Draw it to the `SurfaceTexture`
-    /// pixels.render();
+    /// pixels.render()?;
     /// # Ok::<(), pixels::Error>(())
     /// ```
     pub fn render(&mut self) -> Result<(), Error> {
         self.render_with(|encoder, render_target, context| {
             context.scaling_renderer.render(encoder, render_target);
+
+            Ok(())
         })
     }
 
@@ -312,9 +317,14 @@ impl Pixels {
     /// which you can use to render to the screen, and a [`PixelsContext`] with all of the internal
     /// `wgpu` context.
     ///
+    /// The render function must return a `Result`. This allows fallible render functions to be
+    /// handled gracefully. The boxed `Error` will be made available in the [`Error::UserDefined`]
+    /// variant returned by `render_with()`.
+    ///
     /// # Errors
     ///
-    /// Returns an error when [`wgpu::Surface::get_current_frame`] fails.
+    /// Returns an error when either [`wgpu::Surface::get_current_frame`] or the provided render
+    /// function fails.
     ///
     /// # Example
     ///
@@ -337,12 +347,17 @@ impl Pixels {
     /// pixels.render_with(|encoder, render_target, context| {
     ///     context.scaling_renderer.render(encoder, render_target);
     ///     // etc...
-    /// });
+    ///     Ok(())
+    /// })?;
     /// # Ok::<(), pixels::Error>(())
     /// ```
     pub fn render_with<F>(&mut self, render_function: F) -> Result<(), Error>
     where
-        F: FnOnce(&mut wgpu::CommandEncoder, &wgpu::TextureView, &PixelsContext),
+        F: FnOnce(
+            &mut wgpu::CommandEncoder,
+            &wgpu::TextureView,
+            &PixelsContext,
+        ) -> Result<(), Box<dyn std::error::Error>>,
     {
         let frame = self
             .context
@@ -389,8 +404,8 @@ impl Pixels {
             .texture
             .create_view(&wgpu::TextureViewDescriptor::default());
 
-        // Call the users render function.
-        (render_function)(&mut encoder, &view, &self.context);
+        // Call the user's render function.
+        (render_function)(&mut encoder, &view, &self.context)?;
 
         self.context.queue.submit(Some(encoder.finish()));
         Ok(())