Resync with WGPU 0.20.

CHANGELOG.md

@@ -16,6 +16,7 @@ Per Keep a Changelog there are 6 main categories of changes:
 
 ## Versions
 
+- [v0.20.0] (#v0.20.0)
 - [Unreleased](#unreleased)
 - [v0.3.0](#v030)
 - [v0.2.0](#v020)
@@ -29,6 +30,27 @@ Per Keep a Changelog there are 6 main categories of changes:
 - [v0.0.1](#v001)
 - [Diffs](#diffs)
 
+## v0.23.1
+
+### Major Changes
+None
+
+### Changes
+- Upgraded dependent packages to WGPU 0.23, and appropriate versions of Egui and Winit.
+### Fixes
+- Probably fixed issue 3: https://github.com/John-Nagle/rend3-hp/issues/3
+- Fixed issue 4: https://github.com/John-Nagle/rend3-hp/issues/4
+
+## v0.20.0
+
+### Major Changes
+There will be basic maintenance to keep Rend3 alive. (JN).
+
+### Changes
+- Version number advanced to 0.20. From now on, the version will generally follow WGPU.
+- Incorporated all items listed as "Unreleased".
+- Upgraded dependent packages to WGPU 0.20, and appropriate versions of Egui and Winit.
+
 ## Unreleased
 
 ### Major Changes

Cargo.toml

@@ -12,6 +12,15 @@ members = [
     "rend3-types",
 ]
 
+[workspace.package]
+version = "0.24.2"
+
+[workspace.dependencies]
+wgpu = "^24.0.1"
+wgpu-types = "^24.0.0"
+wgpu-profiler = "^0.21.0"
+glam = "^0.29"
+
 [profile.ci]
 inherits = "dev"
 debug = false
@@ -26,17 +35,3 @@ opt-level = 3
 [profile.release]
 debug = true
 lto = "thin"
-
-[patch.crates-io]
-# wgpu = { git = "https://github.com/gfx-rs/wgpu.git", rev = "fac4731288117d951d0944d96cf0b00fa006dd6c" }
-# wgpu-core = { git = "https://github.com/gfx-rs/wgpu.git", rev = "fac4731288117d951d0944d96cf0b00fa006dd6c" }
-# wgpu-hal = { git = "https://github.com/gfx-rs/wgpu.git", rev = "fac4731288117d951d0944d96cf0b00fa006dd6c" }
-# wgpu-types = { git = "https://github.com/gfx-rs/wgpu.git", rev = "fac4731288117d951d0944d96cf0b00fa006dd6c" }
-# wgpu = { git = "https://github.com/cwfitzgerald/wgpu.git", rev = "bda861f77e0ca0b97697850ad19d19a8b8f1cc9c" }
-# wgpu-core = { git = "https://github.com/cwfitzgerald/wgpu.git", rev = "bda861f77e0ca0b97697850ad19d19a8b8f1cc9c" }
-# wgpu-hal = { git = "https://github.com/cwfitzgerald/wgpu.git", rev = "bda861f77e0ca0b97697850ad19d19a8b8f1cc9c" }
-# wgpu-types = { git = "https://github.com/cwfitzgerald/wgpu.git", rev = "bda861f77e0ca0b97697850ad19d19a8b8f1cc9c" }
-# wgpu = { path = "../wgpu/wgpu" }
-# wgpu-core = { path = "../wgpu/wgpu-core" }
-# wgpu-hal = { path = "../wgpu/wgpu-hal" }
-# wgpu-types = { path = "../wgpu/wgpu-types" }

NOTES.md

@@ -0,0 +1,136 @@
+# Development notes
+John Nagle
+[email protected]
+
+Reviving Rend3 after its abandonment.
+
+## 2024-10-12
+
+Changes to WGPU have broken Rend3. The worst change is
+
+https://github.com/gfx-rs/wgpu/pull/5884
+
+which changes the lifetime of "RenderPass" and Encoder to 'static
+
+which generates this problem:
+
+https://users.rust-lang.org/t/unexpected-borrowed-data-escapes-outside-of-closure-for-generic/119501/4
+
+RenderPass and Controller ownership is currently manipulated by unsafe code. 
+That needs to be figured out. 
+
+###Trouble spot: take_rpass
+
+https://github.com/BVE-Reborn/rend3/blob/d088a841b0469d07d5a7ff3f4d784e97b4a194d5/rend3/src/graph/encpass.rs#L74
+
+    pub(super) enum RenderGraphEncoderOrPassInner<'a, 'pass> {
+        Encoder(&'a mut CommandEncoder),
+        RenderPass(&'a mut RenderPass<'pass>),
+        #[default]
+        None,
+    }   
+
+    pub struct RenderGraphEncoderOrPass<'a, 'pass>(pub(super) RenderGraphEncoderOrPassInner<'a, 'pass>);
+    ...
+    pub fn take_rpass(&mut self, _handle: DeclaredDependency<RenderPassHandle>) -> &'a mut RenderPass<'pass> {
+    match mem::take(&mut self.0) {
+
+This in itself seems legit, i.e. safe. Except that it's taking a mutable reference, not the object itself.
+There can only be one such mutable reference. Where does this come from?
+
+Around here:
+
+  https://github.com/BVE-Reborn/rend3/blob/d088a841b0469d07d5a7ff3f4d784e97b4a194d5/rend3/src/graph/graph.rs#L451
+
+where there is unsafe code to seemingly allow two mutable references to the same object to exist simultaneously.
+
+    // SAFETY: There is no active renderpass to borrow this. This reference lasts for the duration of
+    // the call to exec.
+    None => RenderGraphEncoderOrPassInner::Encoder(unsafe { &mut *encoder_cell.get() }),
+
+Note that this is not an assertion that the code here is safe.
+It is an unchecked constraint on the rest of the program.
+
+Why is this not done with a RefCell and .borrow_mut?
+
+Other than the mess around RenderPass, there's not that much unsafe code in rend3.
+This might be fixable.
+
+Maybe if we pass around something that has a RefCell<RenderGraphEncoderOrPassInner>
+to everybody who needs that...
+But that encapsulates a mutable reference. Who actually *owns* the thing?
+Question: if we put RenderPass and Encoder inside an Rc<RefCell<>>, will that work?
+Or will we panic at borrows?
+Worth a try.
+
+## 2024-10-13
+
+Who actually owns RenderPass and Encoder?
+
+    RenderGraphEncoderOrPassInner holds an &mut of CommandEncoder or RenderPass
+
+Who actually creates RenderGraphEncoderOrPassInner?
+* Created in graph.rs execute
+
+  https://github.com/BVE-Reborn/rend3/blob/d088a841b0469d07d5a7ff3f4d784e97b4a194d5/rend3/src/graph/graph.rs#L451
+
+      RenderGraphEncoderOrPassInner::RenderPass(rpass)
+
+  https://github.com/BVE-Reborn/rend3/blob/d088a841b0469d07d5a7ff3f4d784e97b4a194d5/rend3/src/graph/graph.rs#L455
+
+       None => RenderGraphEncoderOrPassInner::Encoder(unsafe { &mut *encoder_cell.get() }),
+
+  Unsafe code. Is this really necessary?
+
+  https://github.com/BVE-Reborn/rend3/blob/d088a841b0469d07d5a7ff3f4d784e97b4a194d5/rend3/src/graph/graph.rs#L484
+
+  Same situation.
+
+  That's a get from an UnsafeCell. That's probably what should be a RefCell.
+  The UnsafeCell actually owns the encoder. 
+  Who owns the RenderPass? 
+  The caller of 
+      create_rpass_from_desc
+
+### First cut at design:
+
+      create_rpass_from_desc
+
+returns an Rc<RefCell<RenderPass>>.
+
+At line 391 in graph.rs,
+  encoder_cell becomes an Rc<RefCell>> of a new command encoder.
+
+Similarly for rpass_temps_cell.
+
+RenderGraphEncoderOrPassInner must hold an Rc<RefCell<>> for each item.
+
+So where do we do the borrows?
+
+At the unsafe points? Probably.
+
+What about take_rpass? 
+Do the borrow at self.internal.render in lib.rs? 
+
+This will probably all compile and it's all safe code. If the comments about safety are true,
+the borrow_mut calls should not fail. We will see.
+
+## 2024-10-14
+
+Fix all other compile errors from Winit changes. [DONE]
+
+## 2024-10-16
+
+Completed fixing Winit problems, with event loop disabled.
+Time to do the above changes to Rend3.
+
+Most of it now compiles.
+
+Trouble at line 507 of graph.rs
+
+
+
+
+
+
+

examples/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rend3-examples-package"
 license = "MIT OR Apache-2.0 OR Zlib"
-version = "0.3.0"
+version.workspace = true
 authors = ["The rend3 Developers"]
 edition = "2021"
 publish = false
@@ -14,19 +14,21 @@ crate-type = ["lib", "cdylib"]
 name = "rend3-examples"
 path = "src/main.rs"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[features]
+# Enable Tracy tracing for scene-viewer
+tracy = ["tracy-client"]
 
 [dependencies]
 # error handling
 anyhow = "1"
 # The egui immediate mode gui library
-egui = "0.26"
+egui = "0.31"
 # Winit integration with egui (turn off the clipboard feature)
-egui-winit = { version = "0.26", default-features = false, features = ["links", "wayland"] }
+egui-winit = { version = "0.31", default-features = false, features = ["links", "wayland"] }
 # logging
 env_logger = { version = "0.11", default-features = false, features = ["auto-color", "humantime"] }
 # Linear algebra library
-glam = "0.25"
+glam = { workspace = true }
 # gltf model loading
 gltf = "1.4"
 # Channel
@@ -36,7 +38,7 @@ log = "0.4"
 # Inline string
 indoc = "2"
 # Importing images
-image = { version = "0.24", default-features = false, features = [
+image = { version = "0.25", default-features = false, features = [
     "png",
     "jpeg",
     "tiff",
@@ -48,27 +50,28 @@ pico-args = "0.5"
 # block on async functions
 pollster = "0.3"
 # Renderer core
-rend3 = { version = "^0.3.0", path = "../rend3" }
+rend3 = { path = "../rend3" }
 # Play animations on imported gltf models
-rend3-anim = { version = "^0.3.0", path = "../rend3-anim" }
+rend3-anim = { path = "../rend3-anim" }
 # Egui integration with rend3
-rend3-egui = { version = "^0.3.0", path = "../rend3-egui" }
+rend3-egui = { path = "../rend3-egui" }
 # Programmable render list that dictates how the scene renders
-rend3-routine = { version = "^0.3.0", path = "../rend3-routine" }
+rend3-routine = { path = "../rend3-routine" }
 # Framework that deals with the event loop, setting up the renderer, and platform differences.
-rend3-framework = { version = "^0.3.0", path = "../rend3-framework" }
+rend3-framework = { path = "../rend3-framework" }
 # Import gltf models
-rend3-gltf = { version = "^0.3.0", path = "../rend3-gltf" }
+rend3-gltf = { path = "../rend3-gltf" }
 # Opening URL's
-webbrowser = "0.8.2"
+webbrowser = "1"
 # Instant but portable to the web
 web-time = "1.1"
 # windowing
-winit = "0.29.4"
+winit = "0.30"
 # Integration with wgpu
-wgpu = "0.19.0"
+wgpu = { workspace = true }
 # Profiling with wgpu
-wgpu-profiler = "0.16.0"
+wgpu-profiler = { workspace = true }
+tracy-client = { version = "0.17", optional=true }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 console_log = "1"
@@ -83,7 +86,7 @@ wasm-bindgen-futures = "0.4"
 ndk-glue = { version = "0.7", features = ["logger"] }
 
 [dev-dependencies]
-rend3-test = { version = "^0.3.0", path = "../rend3-test" }
+rend3-test = { path = "../rend3-test" }
 tokio = "1"
 
 [target.'cfg(target_arch = "wasm32")'.dev-dependencies]

examples/src/animation/mod.rs

@@ -34,7 +34,11 @@ fn update(renderer: &rend3::Renderer, delta: f32, animated_object: &mut Animated
 }
 
 impl rend3_framework::App for AnimationExample {
-    const HANDEDNESS: rend3::types::Handedness = rend3::types::Handedness::Left;
+    /// Set handedness of coordinate system
+    fn get_handedness(&self) -> rend3::types::Handedness {
+        rend3::types::Handedness::Left    // default
+    }
+
 
     fn sample_count(&self) -> rend3::types::SampleCount {
         SAMPLE_COUNT
@@ -106,7 +110,7 @@ impl rend3_framework::App for AnimationExample {
         self.animated_objects = vec![animated_object, animated_object2];
     }
 
-    fn handle_redraw(&mut self, context: rend3_framework::RedrawContext<'_, ()>) {
+    fn handle_redraw(&mut self, context: rend3_framework::RedrawContext<'_>) {
         self.animated_objects.iter_mut().for_each(|animated_object| {
             update(context.renderer, context.delta_t_seconds, animated_object);
         });
@@ -161,7 +165,7 @@ pub fn main() {
     let app = AnimationExample::default();
     rend3_framework::start(
         app,
-        winit::window::WindowBuilder::new().with_title("animation-example").with_maximized(true),
+        winit::window::WindowAttributes::default().with_title("animation-example").with_maximized(true),
     );
 }
 

examples/src/cube/mod.rs

@@ -61,7 +61,11 @@ pub struct CubeExample {
 }
 
 impl rend3_framework::App for CubeExample {
-    const HANDEDNESS: rend3::types::Handedness = rend3::types::Handedness::Left;
+    //////const HANDEDNESS: rend3::types::Handedness = rend3::types::Handedness::Left;
+    /// Set handedness of coordinate system
+    fn get_handedness(&self) -> rend3::types::Handedness {
+        rend3::types::Handedness::Left    // default
+    }
 
     fn sample_count(&self) -> rend3::types::SampleCount {
         SAMPLE_COUNT
@@ -134,7 +138,7 @@ impl rend3_framework::App for CubeExample {
         }
     }
 
-    fn handle_redraw(&mut self, context: rend3_framework::RedrawContext<'_, ()>) {
+    fn handle_redraw(&mut self, context: rend3_framework::RedrawContext<'_>) {
         // Swap the instruction buffers so that our frame's changes can be processed.
         context.renderer.swap_instruction_buffers();
         // Evaluate our frame's world-change instructions
@@ -183,7 +187,7 @@ impl rend3_framework::App for CubeExample {
 
 pub fn main() {
     let app = CubeExample::default();
-    rend3_framework::start(app, winit::window::WindowBuilder::new().with_title("cube-example").with_maximized(true));
+    rend3_framework::start(app, winit::window::WindowAttributes::default().with_title("cube-example").with_maximized(true));
 }
 
 #[cfg(test)]

examples/src/cube_no_framework/mod.rs

@@ -62,9 +62,10 @@ pub fn main() {
     // Create event loop and window
     let event_loop = winit::event_loop::EventLoop::new().unwrap();
     let window = {
-        let mut builder = winit::window::WindowBuilder::new();
-        builder = builder.with_title("rend3 cube");
-        builder.build(&event_loop).expect("Could not build window")
+        let mut window_attributes = winit::window::WindowAttributes::default();
+        window_attributes = window_attributes.with_title("rend3 cube");
+        //////builder.build(&event_loop).expect("Could not build window")
+        event_loop.create_window(window_attributes).expect("Could not build window") // (JN) for winit 0.30
     };
 
     let window_size = window.inner_size();