fix: renderling build workspace (#215)

* don't require CARGO_WORKSPACE_DIR

* fix test paths

* move BlockFuture to lib and gate with 'test-utils' feature flag

* fix lints

* derive Debug for all

* allow clippy::manual_is_multiple_of on GPU code since rust-gpu is not yet on 1.91

Author: schell

Cargo.lock

@@ -76,3 +76,6 @@ opt-level = 3
 
 [patch.crates-io]
 spirv-std = { git = "https://github.com/rust-gpu/rust-gpu.git", rev = "05b34493ce661dccd6694cf58afc13e3c8f7a7e0" }
+
+[workspace.lints.rust]
+unexpected_cfgs = { level = "allow", check-cfg = [ 'cfg(spirv)' ] }

Cargo.toml

@@ -22,6 +22,13 @@ Just pro-cons on tech choices and little things I don't want to forget whil impl
 
 ## cons / limititions / gotchas
 
+* Can't use an array as a slice, it causes this error:
+  ```
+  error: cannot cast between pointer types
+         from `*[u32; 3]`
+           to `*[u32]`  
+  ```
+  See the ticket I opened <https://github.com/Rust-GPU/rust-gpu/issues/465>
 * ~~can't use enums (but you can't in glsl or hlsl or msl or wgsl either)~~ you _can_ but they must be simple (like `#[repr(u32)]`)
 * ~~struct layout size/alignment errors can be really tricky~~ solved by using a slab
 * rust code must be no-std

NOTES.md

@@ -9,4 +9,5 @@ edition = "2021"
 glam = { workspace = true, features = ["std"] }
 image.workspace = true
 log.workspace = true
+renderling_build = { path = "../renderling-build" }
 snafu = "^0.7"

crates/img-diff/Cargo.toml

@@ -1,23 +1,19 @@
 //! Provides image diffing for testing.
 use glam::{Vec3, Vec4, Vec4Swizzles};
 use image::{DynamicImage, Luma, Rgb, Rgb32FImage, Rgba32FImage};
+use renderling_build::{test_img_dir, test_output_dir};
 use snafu::prelude::*;
-use std::path::Path;
 
-pub const TEST_IMG_DIR: &str = concat!(std::env!("CARGO_WORKSPACE_DIR"), "test_img");
-pub const TEST_OUTPUT_DIR: &str = concat!(std::env!("CARGO_WORKSPACE_DIR"), "test_output");
-pub const WASM_TEST_OUTPUT_DIR: &str =
-    concat!(std::env!("CARGO_WORKSPACE_DIR"), "test_output/wasm");
 const PIXEL_MAGNITUDE_THRESHOLD: f32 = 0.1;
 pub const LOW_PIXEL_THRESHOLD: f32 = 0.02;
 const IMAGE_DIFF_THRESHOLD: f32 = 0.05;
 
 fn checkerboard_background_color(x: u32, y: u32) -> Vec3 {
     let size = 16;
     let x_square_index = x / size;
-    let x_grey = x_square_index % 2 == 0;
+    let x_grey = x_square_index.is_multiple_of(2);
     let y_square_index = y / size;
-    let y_grey = y_square_index % 2 == 0;
+    let y_grey = y_square_index.is_multiple_of(2);
     if (x_grey && y_grey) || (!x_grey && !y_grey) {
         Vec3::from([0.5, 0.5, 0.5])
     } else {
@@ -44,7 +40,7 @@ pub struct DiffCfg {
     /// The name of the test.
     pub test_name: Option<&'static str>,
     /// The output directory to store comparisons in.
-    pub output_dir: &'static str,
+    pub output_dir: std::path::PathBuf,
 }
 
 impl Default for DiffCfg {
@@ -53,7 +49,7 @@ impl Default for DiffCfg {
             pixel_threshold: PIXEL_MAGNITUDE_THRESHOLD,
             image_threshold: IMAGE_DIFF_THRESHOLD,
             test_name: None,
-            output_dir: TEST_OUTPUT_DIR,
+            output_dir: test_output_dir(),
         }
     }
 }
@@ -143,7 +139,7 @@ pub fn save_to(
 }
 
 pub fn save(filename: impl AsRef<std::path::Path>, seen: impl Into<DynamicImage>) {
-    save_to(TEST_OUTPUT_DIR, filename, seen).unwrap()
+    save_to(test_output_dir(), filename, seen).unwrap()
 }
 
 pub fn assert_eq_cfg(
@@ -185,7 +181,7 @@ pub fn assert_eq_cfg(
             return Ok(());
         }
 
-        let mut dir = Path::new(output_dir).join(test_name.unwrap_or(filename));
+        let mut dir = output_dir.join(test_name.unwrap_or(filename));
         dir.set_extension("");
         std::fs::create_dir_all(&dir).expect("cannot create test output dir");
         let expected = dir.join("expected.png");
@@ -228,7 +224,7 @@ pub fn assert_img_eq_cfg_result(
     seen: impl Into<DynamicImage>,
     cfg: DiffCfg,
 ) -> Result<(), String> {
-    let path = Path::new(TEST_IMG_DIR).join(filename);
+    let path = test_img_dir().join(filename);
     let lhs = image::open(&path)
         .unwrap_or_else(|e| panic!("can't open expected image '{}': {e}", path.display(),));
     assert_eq_cfg(filename, lhs, seen, cfg)

crates/img-diff/src/lib.rs

@@ -138,15 +138,37 @@ fn wgsl(spv_filepath: impl AsRef<std::path::Path>, destination: impl AsRef<std::
 }
 
 /// The cargo workspace directory.
+///
+/// ## Panics
+/// Panics if not called from a checkout of the renderling repo.
 pub fn workspace_dir() -> std::path::PathBuf {
-    std::path::PathBuf::from(std::env!("CARGO_WORKSPACE_DIR"))
+    std::path::PathBuf::from(std::env::var("CARGO_WORKSPACE_DIR").unwrap())
+}
+
+/// The test_img directory.
+///
+/// ## Panics
+/// Panics if not called from a checkout of the renderling repo.
+pub fn test_img_dir() -> std::path::PathBuf {
+    workspace_dir().join("test_img")
 }
 
 /// The test_output directory.
+///
+/// ## Panics
+/// Panics if not called from a checkout of the renderling repo.
 pub fn test_output_dir() -> std::path::PathBuf {
     workspace_dir().join("test_output")
 }
 
+/// The WASM test_output directory.
+///
+/// ## Panics
+/// Panics if not called from a checkout of the renderling repo.
+pub fn wasm_test_output_dir() -> std::path::PathBuf {
+    test_output_dir().join("wasm")
+}
+
 #[derive(Debug)]
 pub struct RenderlingPaths {
     /// `cargo_workspace` is not available when building outside of the project directory.

crates/renderling-build/src/lib.rs

@@ -26,7 +26,7 @@ crate-type = ["rlib", "cdylib"]
 default = ["gltf", "ui", "winit"]
 gltf = ["dep:gltf", "dep:serde_json"]
 test_i8_i16_extraction = []
-test-utils = ["dep:metal", "dep:wgpu-core"]
+test-utils = ["dep:metal", "dep:wgpu-core", "dep:futures-lite"]
 ui = ["dep:glyph_brush", "dep:loading-bytes", "dep:lyon"]
 wasm = ["wgpu/fragile-send-sync-non-atomic-wasm"]
 debug-slab = []
@@ -57,8 +57,9 @@ async-channel = {workspace = true}
 bytemuck = {workspace = true}
 craballoc.workspace = true
 crabslab = { workspace = true, features = ["default"] }
-dagga = {workspace=true}
 crunch = "0.5"
+dagga = {workspace=true}
+futures-lite = { workspace = true, optional = true }
 glam = { workspace = true, features = ["std"] }
 gltf = {workspace = true, optional = true}
 glyph_brush = {workspace = true, optional = true}
@@ -114,3 +115,6 @@ features = [
   "Navigator",
   "Window"
 ]
+
+[lints]
+workspace = true

crates/renderling/Cargo.toml

@@ -24,8 +24,9 @@ pub use cpu::*;
 pub mod shader;
 
 /// Method of addressing the edges of a texture.
-#[cfg_attr(not(target_arch = "spirv"), derive(Debug))]
-#[derive(Clone, Copy, Default, PartialEq, Eq, Hash, PartialOrd, Ord, SlabItem)]
+#[derive(
+    Clone, Copy, Default, PartialEq, Eq, Hash, PartialOrd, Ord, SlabItem, core::fmt::Debug,
+)]
 pub struct TextureModes {
     pub s: TextureAddressMode,
     pub t: TextureAddressMode,
@@ -56,9 +57,10 @@ pub fn clamp(input: f32) -> f32 {
 }
 
 /// How edges should be handled in texture addressing/wrapping.
-#[cfg_attr(not(target_arch = "spirv"), derive(Debug))]
 #[repr(u32)]
-#[derive(Clone, Copy, Default, PartialEq, Eq, Hash, PartialOrd, Ord, SlabItem)]
+#[derive(
+    Clone, Copy, Default, PartialEq, Eq, Hash, PartialOrd, Ord, SlabItem, core::fmt::Debug,
+)]
 pub enum TextureAddressMode {
     #[default]
     ClampToEdge,
@@ -93,7 +95,16 @@ impl TextureAddressMode {
             TextureAddressMode::MirroredRepeat => {
                 let sign = if input >= 0.0 { 1.0f32 } else { -1.0 };
                 let i = input.abs();
-                let flip = i as u32 % 2 == 0;
+                // TODO: Remove this clippy allowance after <https://github.com/Rust-GPU/rust-gpu/pull/460>
+                // merges.
+                #[cfg_attr(
+                    cpu,
+                    expect(
+                        clippy::manual_is_multiple_of,
+                        reason = "rust-gpu is not yet on rustc 1.91, which introduced this lint"
+                    )
+                )]
+                let flip = ((i as u32) % 2) == 0;
                 let t = repeat(i);
                 if sign > 0.0 {
                     if flip {

crates/renderling/src/atlas.rs

@@ -668,7 +668,7 @@ fn pack_images<'a>(
             )
             .collect()
     };
-    new_packing.sort_by_key(|a| (a.size().length_squared()));
+    new_packing.sort_by_key(|a| a.size().length_squared());
     let total_images = new_packing.len();
     let new_packing_layers: Vec<Vec<AnotherPacking>> =
         fan_split_n(extent.depth_or_array_layers as usize, new_packing);

crates/renderling/src/atlas/cpu.rs

@@ -9,8 +9,7 @@ pub struct AtlasDescriptor {
 }
 
 /// A texture inside the atlas.
-#[cfg_attr(not(target_arch = "spirv"), derive(Debug))]
-#[derive(Clone, Copy, Default, PartialEq, SlabItem)]
+#[derive(Clone, Copy, Default, PartialEq, SlabItem, core::fmt::Debug)]
 pub struct AtlasTextureDescriptor {
     /// The top left offset of texture in the atlas.
     pub offset_px: UVec2,