Rework wgpu-rs Context (#6619)

Cargo.toml

@@ -124,6 +124,7 @@ serde_json = "1.0.133"
 smallvec = "1"
 static_assertions = "1.1.0"
 strum = { version = "0.25.0", features = ["derive"] }
+trybuild = "1"
 tracy-client = "0.17"
 thiserror = "1.0.69"
 wgpu = { version = "23.0.1", path = "./wgpu", default-features = false }

tests/Cargo.toml

@@ -16,6 +16,11 @@ name = "wgpu-test"
 path = "tests/root.rs"
 harness = false
 
+[[test]]
+name = "wgpu-compile-test"
+path = "compile_tests/root.rs"
+harness = true
+
 [features]
 webgl = ["wgpu/webgl"]
 
@@ -27,6 +32,7 @@ bytemuck.workspace = true
 cfg-if.workspace = true
 ctor.workspace = true
 futures-lite.workspace = true
+glam.workspace = true
 itertools.workspace = true
 libtest-mimic.workspace = true
 log.workspace = true
@@ -37,10 +43,10 @@ profiling.workspace = true
 serde_json.workspace = true
 serde.workspace = true
 strum = { workspace = true, features = ["derive"] }
-wgpu-macros.workspace = true
+trybuild.workspace = true
 wgpu = { workspace = true, features = ["wgsl"] }
+wgpu-macros.workspace = true
 wgt = { workspace = true, features = ["serde"] }
-glam.workspace = true
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 env_logger.workspace = true

tests/compile_tests/fail/cpass_lifetime.rs

@@ -0,0 +1,18 @@
+// Test to ensure that ComputePass without forget_lifetime does not compile
+// when the ComputePass is dropped before the CommandBuffer is finished.
+//
+// See #6145 for more info.
+
+fn main() {
+    let instance = wgpu::Instance::new(Default::default());
+    let adapter = pollster::block_on(instance.request_adapter(&Default::default())).unwrap();
+    let (device, queue) =
+        pollster::block_on(adapter.request_device(&Default::default(), None)).unwrap();
+
+    let mut encoder = device.create_command_encoder(&Default::default());
+    let _compute_pass = encoder.begin_compute_pass(&Default::default());
+    // set up the compute pass...
+
+    let cmd_buffer = encoder.finish();
+    queue.submit([cmd_buffer]);
+}

tests/compile_tests/fail/cpass_lifetime.stderr

@@ -0,0 +1,13 @@
+error[E0505]: cannot move out of `encoder` because it is borrowed
+  --> compile_tests/fail/cpass_lifetime.rs:16:22
+   |
+12 |     let mut encoder = device.create_command_encoder(&Default::default());
+   |         ----------- binding `encoder` declared here
+13 |     let _compute_pass = encoder.begin_compute_pass(&Default::default());
+   |                         ------- borrow of `encoder` occurs here
+...
+16 |     let cmd_buffer = encoder.finish();
+   |                      ^^^^^^^ move out of `encoder` occurs here
+17 |     queue.submit([cmd_buffer]);
+18 | }
+   | - borrow might be used here, when `_compute_pass` is dropped and runs the destructor for type `wgpu::ComputePass<'_>`

tests/compile_tests/fail/rpass_lifetime.rs

@@ -0,0 +1,18 @@
+// Test to ensure that ComputePass without forget_lifetime does not compile
+// when the ComputePass is dropped before the CommandBuffer is finished.
+//
+// See #6145 for more info.
+
+fn main() {
+    let instance = wgpu::Instance::new(Default::default());
+    let adapter = pollster::block_on(instance.request_adapter(&Default::default())).unwrap();
+    let (device, queue) =
+        pollster::block_on(adapter.request_device(&Default::default(), None)).unwrap();
+
+    let mut encoder = device.create_command_encoder(&Default::default());
+    let _render_pass = encoder.begin_render_pass(&Default::default());
+    // set up the render pass...
+
+    let cmd_buffer = encoder.finish();
+    queue.submit([cmd_buffer]);
+}

tests/compile_tests/fail/rpass_lifetime.stderr

@@ -0,0 +1,13 @@
+error[E0505]: cannot move out of `encoder` because it is borrowed
+  --> compile_tests/fail/rpass_lifetime.rs:16:22
+   |
+12 |     let mut encoder = device.create_command_encoder(&Default::default());
+   |         ----------- binding `encoder` declared here
+13 |     let _render_pass = encoder.begin_render_pass(&Default::default());
+   |                        ------- borrow of `encoder` occurs here
+...
+16 |     let cmd_buffer = encoder.finish();
+   |                      ^^^^^^^ move out of `encoder` occurs here
+17 |     queue.submit([cmd_buffer]);
+18 | }
+   | - borrow might be used here, when `_render_pass` is dropped and runs the destructor for type `wgpu::RenderPass<'_>`

tests/compile_tests/root.rs

@@ -0,0 +1,7 @@
+// Tests that ensure that various constructs that should not compile do not compile.
+
+#[test]
+fn compile_fail() {
+    let t = trybuild::TestCases::new();
+    t.compile_fail("compile_tests/fail/*.rs");
+}

tests/tests/external_texture.rs

@@ -274,7 +274,7 @@ static IMAGE_BITMAP_IMPORT: GpuTestConfiguration =
                                 origin: src_origin,
                                 flip_y: src_flip_y,
                             },
-                            wgpu::CopyExternalImageDestInfo {
+                            wgt::CopyExternalImageDestInfo {
                                 texture: &texture,
                                 mip_level: 0,
                                 origin: dest_origin,

wgpu-core/src/global.rs

@@ -1,4 +1,4 @@
-use std::sync::Arc;
+use std::{fmt, sync::Arc};
 
 use crate::{
     hal_api::HalApi,
@@ -85,6 +85,12 @@ impl Global {
     }
 }
 
+impl fmt::Debug for Global {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_struct("Global").finish()
+    }
+}
+
 impl Drop for Global {
     fn drop(&mut self) {
         profiling::scope!("Global::drop");

wgpu-types/Cargo.toml

@@ -35,7 +35,7 @@ serde = ["dep:serde"]
 counters = []
 
 [dependencies]
-bitflags.workspace = true
+bitflags = { workspace = true, features = ["serde"] }
 serde = { workspace = true, features = ["derive"], optional = true }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]

wgpu/build.rs

@@ -4,7 +4,7 @@ fn main() {
         webgl: { all(target_arch = "wasm32", not(target_os = "emscripten"), feature = "webgl") },
         webgpu: { all(target_arch = "wasm32", not(target_os = "emscripten"), feature = "webgpu") },
         Emscripten: { all(target_arch = "wasm32", target_os = "emscripten") },
-        wgpu_core: { any(native, webgl, emscripten) },
+        wgpu_core: { any(native, webgl, Emscripten) },
         send_sync: { any(
             not(target_arch = "wasm32"),
             all(feature = "fragile-send-sync-non-atomic-wasm", not(target_feature = "atomics"))