From b910cf25646677a0bf1cd6c7eeda495ca8b3912e Mon Sep 17 00:00:00 2001 From: Erich Gubler Date: Wed, 25 Sep 2024 15:37:43 -0400 Subject: [PATCH] =?UTF-8?q?refactor:=20use=20`include=5Fwgsl!(=E2=80=A6)`?= =?UTF-8?q?=20more?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This change uses `include_wgsl!(…)` in usages where an `include_str!("….wgsl")` was used to construct a `ShaderModuleDescriptor`'s `source, but the `label` was set to `None`. This should (1) showcase a nice idiomatic convenience we offer in our examples better, (2) make code more concise, and (3) get some automatically generated labels in diagnostics where it seems it won't hurt. --- CHANGELOG.md | 1 + examples/src/boids/mod.rs | 12 +++--------- examples/src/conservative_raster/mod.rs | 15 +++------------ examples/src/cube/mod.rs | 7 ++----- examples/src/hello_compute/mod.rs | 7 ++----- examples/src/hello_synchronization/mod.rs | 5 +---- examples/src/hello_workgroups/mod.rs | 5 +---- examples/src/mipmap/mod.rs | 12 +++--------- examples/src/msaa_line/mod.rs | 7 ++----- examples/src/render_to_texture/mod.rs | 5 +---- examples/src/repeated_compute/mod.rs | 7 +------ examples/src/shadow/mod.rs | 7 ++----- examples/src/skybox/mod.rs | 7 ++----- examples/src/srgb_blend/mod.rs | 7 ++----- examples/src/stencil_triangles/mod.rs | 6 +----- examples/src/storage_texture/mod.rs | 5 +---- examples/src/timestamp_queries/mod.rs | 5 +---- examples/src/uniform_values/mod.rs | 7 +------ examples/src/water/mod.rs | 12 +++--------- tests/tests/occlusion_query/mod.rs | 7 ++----- tests/tests/partially_bounded_arrays/mod.rs | 7 ++----- tests/tests/subgroup_operations/mod.rs | 7 ++----- 22 files changed, 39 insertions(+), 121 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 894da6ddc7..239b1f7d9b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -142,6 +142,7 @@ By @bradwerth [#6216](https://github.com/gfx-rs/wgpu/pull/6216). ### Documentation - Removed some OpenGL and Vulkan references from `wgpu-types` documentation. Fixed Storage texel types in examples. By @Nelarius in [#6271](https://github.com/gfx-rs/wgpu/pull/6271) +- Used `wgpu::include_wgsl!(…)` more in examples and tests. By @ErichDonGubler in [#6326](https://github.com/gfx-rs/wgpu/pull/6326). ### Dependency Updates diff --git a/examples/src/boids/mod.rs b/examples/src/boids/mod.rs index c527be96d9..6335bed811 100644 --- a/examples/src/boids/mod.rs +++ b/examples/src/boids/mod.rs @@ -2,7 +2,7 @@ // adapted from https://github.com/austinEng/webgpu-samples/blob/master/src/examples/computeBoids.ts use nanorand::{Rng, WyRand}; -use std::{borrow::Cow, mem::size_of}; +use std::mem::size_of; use wgpu::util::DeviceExt; // number of boid particles to simulate @@ -43,14 +43,8 @@ impl crate::framework::Example for Example { device: &wgpu::Device, _queue: &wgpu::Queue, ) -> Self { - let compute_shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("compute.wgsl"))), - }); - let draw_shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("draw.wgsl"))), - }); + let compute_shader = device.create_shader_module(wgpu::include_wgsl!("compute.wgsl")); + let draw_shader = device.create_shader_module(wgpu::include_wgsl!("draw.wgsl")); // buffer for simulation parameters uniform diff --git a/examples/src/conservative_raster/mod.rs b/examples/src/conservative_raster/mod.rs index 46fb8742a0..681c45c83d 100644 --- a/examples/src/conservative_raster/mod.rs +++ b/examples/src/conservative_raster/mod.rs @@ -1,5 +1,3 @@ -use std::borrow::Cow; - const RENDER_TARGET_FORMAT: wgpu::TextureFormat = wgpu::TextureFormat::Rgba8UnormSrgb; struct Example { @@ -83,12 +81,8 @@ impl crate::framework::Example for Example { push_constant_ranges: &[], }); - let shader_triangle_and_lines = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!( - "triangle_and_lines.wgsl" - ))), - }); + let shader_triangle_and_lines = + device.create_shader_module(wgpu::include_wgsl!("triangle_and_lines.wgsl")); let pipeline_triangle_conservative = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { @@ -203,10 +197,7 @@ impl crate::framework::Example for Example { bind_group_layouts: &[&bind_group_layout], push_constant_ranges: &[], }); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("upscale.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("upscale.wgsl")); ( device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { label: Some("Upscale"), diff --git a/examples/src/cube/mod.rs b/examples/src/cube/mod.rs index 78dc06e061..bc7504411d 100644 --- a/examples/src/cube/mod.rs +++ b/examples/src/cube/mod.rs @@ -1,5 +1,5 @@ use bytemuck::{Pod, Zeroable}; -use std::{borrow::Cow, f32::consts, mem::size_of}; +use std::{f32::consts, mem::size_of}; use wgpu::util::DeviceExt; #[repr(C)] @@ -216,10 +216,7 @@ impl crate::framework::Example for Example { label: None, }); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let vertex_buffers = [wgpu::VertexBufferLayout { array_stride: vertex_size as wgpu::BufferAddress, diff --git a/examples/src/hello_compute/mod.rs b/examples/src/hello_compute/mod.rs index e53f49fa43..35cfcfbabb 100644 --- a/examples/src/hello_compute/mod.rs +++ b/examples/src/hello_compute/mod.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, mem::size_of_val, str::FromStr}; +use std::{mem::size_of_val, str::FromStr}; use wgpu::util::DeviceExt; // Indicates a u32 overflow in an intermediate Collatz value @@ -66,10 +66,7 @@ async fn execute_gpu_inner( numbers: &[u32], ) -> Option> { // Loads the shader from WGSL - let cs_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let cs_module = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); // Gets the size in bytes of the buffer. let size = size_of_val(numbers) as wgpu::BufferAddress; diff --git a/examples/src/hello_synchronization/mod.rs b/examples/src/hello_synchronization/mod.rs index fad5d7a9da..b186c2bf04 100644 --- a/examples/src/hello_synchronization/mod.rs +++ b/examples/src/hello_synchronization/mod.rs @@ -56,10 +56,7 @@ async fn execute( let mut local_patient_workgroup_results = vec![0u32; result_vec_size]; let mut local_hasty_workgroup_results = local_patient_workgroup_results.clone(); - let shaders_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!("shaders.wgsl"))), - }); + let shaders_module = device.create_shader_module(wgpu::include_wgsl!("shaders.wgsl")); let storage_buffer = device.create_buffer(&wgpu::BufferDescriptor { label: None, diff --git a/examples/src/hello_workgroups/mod.rs b/examples/src/hello_workgroups/mod.rs index 7a653cf3e8..38c88a6924 100644 --- a/examples/src/hello_workgroups/mod.rs +++ b/examples/src/hello_workgroups/mod.rs @@ -41,10 +41,7 @@ async fn run() { .await .unwrap(); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let storage_buffer_a = device.create_buffer_init(&wgpu::util::BufferInitDescriptor { label: None, diff --git a/examples/src/mipmap/mod.rs b/examples/src/mipmap/mod.rs index 179970ad7f..edfcf22231 100644 --- a/examples/src/mipmap/mod.rs +++ b/examples/src/mipmap/mod.rs @@ -1,5 +1,5 @@ use bytemuck::{Pod, Zeroable}; -use std::{borrow::Cow, f32::consts, mem::size_of}; +use std::{f32::consts, mem::size_of}; use wgpu::util::DeviceExt; const TEXTURE_FORMAT: wgpu::TextureFormat = wgpu::TextureFormat::Rgba8UnormSrgb; @@ -81,10 +81,7 @@ impl Example { query_sets: &Option, mip_count: u32, ) { - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("blit.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("blit.wgsl")); let pipeline = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { label: Some("blit"), @@ -281,10 +278,7 @@ impl crate::framework::Example for Example { }); // Create the render pipeline - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("draw.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("draw.wgsl")); let draw_pipeline = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { label: Some("draw"), diff --git a/examples/src/msaa_line/mod.rs b/examples/src/msaa_line/mod.rs index 431fe02bab..1f49b90f4a 100644 --- a/examples/src/msaa_line/mod.rs +++ b/examples/src/msaa_line/mod.rs @@ -7,7 +7,7 @@ //! * Set the primitive_topology to PrimitiveTopology::LineList. //! * Vertices and Indices describe the two points that make up a line. -use std::{borrow::Cow, iter, mem::size_of}; +use std::{iter, mem::size_of}; use bytemuck::{Pod, Zeroable}; use wgpu::util::DeviceExt; @@ -156,10 +156,7 @@ impl crate::framework::Example for Example { let sample_count = max_sample_count; - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { label: None, diff --git a/examples/src/render_to_texture/mod.rs b/examples/src/render_to_texture/mod.rs index 1d6f488d52..5295254986 100644 --- a/examples/src/render_to_texture/mod.rs +++ b/examples/src/render_to_texture/mod.rs @@ -28,10 +28,7 @@ async fn run(_path: Option) { .await .unwrap(); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let render_target = device.create_texture(&wgpu::TextureDescriptor { label: None, diff --git a/examples/src/repeated_compute/mod.rs b/examples/src/repeated_compute/mod.rs index 83dcd4099e..7c9ff766da 100644 --- a/examples/src/repeated_compute/mod.rs +++ b/examples/src/repeated_compute/mod.rs @@ -180,12 +180,7 @@ impl WgpuContext { .unwrap(); // Our shader, kindly compiled with Naga. - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!( - "shader.wgsl" - ))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); // This is where the GPU will read from and write to. let storage_buffer = device.create_buffer(&wgpu::BufferDescriptor { diff --git a/examples/src/shadow/mod.rs b/examples/src/shadow/mod.rs index a7edcce7e8..0960a49f2b 100644 --- a/examples/src/shadow/mod.rs +++ b/examples/src/shadow/mod.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, f32::consts, iter, mem::size_of, ops::Range, sync::Arc}; +use std::{f32::consts, iter, mem::size_of, ops::Range, sync::Arc}; use bytemuck::{Pod, Zeroable}; use wgpu::util::{align_to, DeviceExt}; @@ -447,10 +447,7 @@ impl crate::framework::Example for Example { attributes: &vertex_attr, }; - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let shadow_pass = { let uniform_size = size_of::() as wgpu::BufferAddress; diff --git a/examples/src/skybox/mod.rs b/examples/src/skybox/mod.rs index 82e58ef6d5..ae31643799 100644 --- a/examples/src/skybox/mod.rs +++ b/examples/src/skybox/mod.rs @@ -1,5 +1,5 @@ use bytemuck::{Pod, Zeroable}; -use std::{borrow::Cow, f32::consts, mem::size_of}; +use std::{f32::consts, mem::size_of}; use wgpu::{util::DeviceExt, AstcBlock, AstcChannel}; const IMAGE_SIZE: u32 = 256; @@ -168,10 +168,7 @@ impl crate::framework::Example for Example { }); // Create the render pipeline - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let camera = Camera { screen_size: (config.width, config.height), diff --git a/examples/src/srgb_blend/mod.rs b/examples/src/srgb_blend/mod.rs index 822d95d3c4..198483d540 100644 --- a/examples/src/srgb_blend/mod.rs +++ b/examples/src/srgb_blend/mod.rs @@ -1,5 +1,5 @@ use bytemuck::{Pod, Zeroable}; -use std::{borrow::Cow, mem}; +use std::mem; use wgpu::util::DeviceExt; #[repr(C)] @@ -103,10 +103,7 @@ impl crate::framework::Example for Example { label: None, }); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let vertex_buffers = [wgpu::VertexBufferLayout { array_stride: vertex_size as wgpu::BufferAddress, diff --git a/examples/src/stencil_triangles/mod.rs b/examples/src/stencil_triangles/mod.rs index bb433af11c..fcd37f813e 100644 --- a/examples/src/stencil_triangles/mod.rs +++ b/examples/src/stencil_triangles/mod.rs @@ -1,5 +1,4 @@ use bytemuck::{Pod, Zeroable}; -use std::borrow::Cow; use std::mem::size_of; use wgpu::util::DeviceExt; @@ -53,10 +52,7 @@ impl crate::framework::Example for Example { push_constant_ranges: &[], }); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let vertex_buffers = [wgpu::VertexBufferLayout { array_stride: vertex_size as wgpu::BufferAddress, diff --git a/examples/src/storage_texture/mod.rs b/examples/src/storage_texture/mod.rs index a687584196..a394fe9e09 100644 --- a/examples/src/storage_texture/mod.rs +++ b/examples/src/storage_texture/mod.rs @@ -44,10 +44,7 @@ async fn run(_path: Option) { .await .unwrap(); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let storage_texture = device.create_texture(&wgpu::TextureDescriptor { label: None, diff --git a/examples/src/timestamp_queries/mod.rs b/examples/src/timestamp_queries/mod.rs index a253938a3d..eb78630e29 100644 --- a/examples/src/timestamp_queries/mod.rs +++ b/examples/src/timestamp_queries/mod.rs @@ -239,10 +239,7 @@ fn submit_render_and_compute_pass_with_queries( device.create_command_encoder(&wgpu::CommandEncoderDescriptor { label: None }); let mut queries = Queries::new(device, QueryResults::NUM_QUERIES); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); if device .features() diff --git a/examples/src/uniform_values/mod.rs b/examples/src/uniform_values/mod.rs index 1ef58de09a..a5c1e14c54 100644 --- a/examples/src/uniform_values/mod.rs +++ b/examples/src/uniform_values/mod.rs @@ -122,12 +122,7 @@ impl WgpuContext { .await .unwrap(); - let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed(include_str!( - "shader.wgsl" - ))), - }); + let shader = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); // (2) let uniform_buffer = device.create_buffer(&wgpu::BufferDescriptor { diff --git a/examples/src/water/mod.rs b/examples/src/water/mod.rs index 505f5707e5..52acbef37c 100644 --- a/examples/src/water/mod.rs +++ b/examples/src/water/mod.rs @@ -3,7 +3,7 @@ mod point_gen; use bytemuck::{Pod, Zeroable}; use glam::Vec3; use nanorand::{Rng, WyRand}; -use std::{borrow::Cow, f32::consts, iter, mem::size_of}; +use std::{f32::consts, iter, mem::size_of}; use wgpu::util::DeviceExt; /// @@ -493,14 +493,8 @@ impl crate::framework::Example for Example { }); // Upload/compile them to GPU code. - let terrain_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: Some("terrain"), - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("terrain.wgsl"))), - }); - let water_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: Some("water"), - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("water.wgsl"))), - }); + let terrain_module = device.create_shader_module(wgpu::include_wgsl!("terrain.wgsl")); + let water_module = device.create_shader_module(wgpu::include_wgsl!("water.wgsl")); // Create the render pipelines. These describe how the data will flow through the GPU, and what // constraints and modifiers it will have. diff --git a/tests/tests/occlusion_query/mod.rs b/tests/tests/occlusion_query/mod.rs index 20c7fff82b..2cedab0299 100644 --- a/tests/tests/occlusion_query/mod.rs +++ b/tests/tests/occlusion_query/mod.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, mem::size_of}; +use std::mem::size_of; use wgpu_test::{gpu_test, FailureCase, GpuTestConfiguration, TestParameters}; #[gpu_test] @@ -25,10 +25,7 @@ static OCCLUSION_QUERY: GpuTestConfiguration = GpuTestConfiguration::new() // Setup pipeline using a simple shader with hardcoded vertices let shader = ctx .device - .create_shader_module(wgpu::ShaderModuleDescriptor { - label: Some("Shader module"), - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + .create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let pipeline = ctx .device .create_render_pipeline(&wgpu::RenderPipelineDescriptor { diff --git a/tests/tests/partially_bounded_arrays/mod.rs b/tests/tests/partially_bounded_arrays/mod.rs index 4e6d6fc097..eefec6c3fd 100644 --- a/tests/tests/partially_bounded_arrays/mod.rs +++ b/tests/tests/partially_bounded_arrays/mod.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, num::NonZeroU32}; +use std::num::NonZeroU32; use wgpu_test::{gpu_test, image::ReadbackBuffers, GpuTestConfiguration, TestParameters}; @@ -53,10 +53,7 @@ static PARTIALLY_BOUNDED_ARRAY: GpuTestConfiguration = GpuTestConfiguration::new }], }); - let cs_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let cs_module = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { label: Some("main"), diff --git a/tests/tests/subgroup_operations/mod.rs b/tests/tests/subgroup_operations/mod.rs index f874a6bacf..973d824228 100644 --- a/tests/tests/subgroup_operations/mod.rs +++ b/tests/tests/subgroup_operations/mod.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, mem::size_of, num::NonZeroU64}; +use std::{mem::size_of, num::NonZeroU64}; use wgpu_test::{gpu_test, GpuTestConfiguration, TestParameters}; @@ -56,10 +56,7 @@ static SUBGROUP_OPERATIONS: GpuTestConfiguration = GpuTestConfiguration::new() }], }); - let cs_module = device.create_shader_module(wgpu::ShaderModuleDescriptor { - label: None, - source: wgpu::ShaderSource::Wgsl(Cow::Borrowed(include_str!("shader.wgsl"))), - }); + let cs_module = device.create_shader_module(wgpu::include_wgsl!("shader.wgsl")); let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { label: Some("main"),