Raster reorg (#410)

This PR is a big reorganiaztion of `fidget::raster`; this is a step
towards merging the WebGPU backend, which wants a similar module
organization for the WebGPU backend.

- `render2d` and `render3d` modules are renamed to `pixel` and `voxel`,
  respectively
- Types from `fidget::raster::config` are moved to either `pixel` or
  `voxel` modules
- `ImageRenderConfig` and `VoxelRenderConfig` are both renamed to
  `RenderConfig` (in different namespaces)
- Similarly, each namespace contains an `Image` and `RenderSize` type
  definition. `voxel::Image` replaces `GeometryBuffer`; `pixel::Image` is
  equivalent to `fidget::raster::Image<DistancePixel>`.
- Renamed `DistancePixel` to `RawDistancePixel`; added an unpacked `enum
  DistancePixel` (instead of using `Result<f32, PixelFill>` as a weird
  `Either` type
- The tile sizes member of `RenderConfig` is now optional and will fall
  back to the evaluator's tile size if not populated
- This adds a `F: RenderHints` trait bound for many functions in
  `fidget::raster`

Author: mkeeter

CHANGELOG.md

@@ -1,4 +1,20 @@
 # 0.4.4 (unpublished)
+- Big reorganization of `fidget::raster`
+    - `render2d` and `render3d` modules are renamed to `pixel` and `voxel`,
+      respectively
+    - `ImageRenderConfig` and `VoxelRenderConfig` are both renamed to
+      `RenderConfig` (in different namespaces)
+    - Similarly, each namespace contains an `Image` and `RenderSize` type
+      definition.  `voxel::Image` replaces `GeometryBuffer`; `pixel::Image` is
+      equivalent to `fidget::raster::Image<DistancePixel>` in the previous code
+      (but see the next point about renaming!)
+    - Renamed `DistancePixel` to `RawDistancePixel`; added an unpacked `enum
+      DistancePixel` (instead of using `Result<f32, PixelFill>` as a weird
+      `Either` type
+    - The tile sizes member of `RenderConfig` is now optional and will fall back
+      to the evaluator's tile size if not populated
+        - This adds a `F: RenderHints` trait bound for many functions in
+          `fidget::raster`
 - Add `Image::build` function to build an image from a `Vec<T>` and
   `ImageSizeLike`, returning an error if the data size is incorrect.
 - Revamping `fidget-bytecode`

demos/cli/src/main.rs

@@ -279,9 +279,8 @@ fn run3d<F: fidget::eval::Function + fidget::render::RenderHints>(
         None => Some(fidget::render::ThreadPool::Global),
     };
     let threads = threads.as_ref();
-    let cfg = fidget::raster::VoxelRenderConfig {
+    let cfg = fidget::raster::voxel::RenderConfig {
         image_size: fidget::render::VoxelSize::from(settings.size),
-        tile_sizes: F::tile_sizes_3d(),
         threads,
         world_to_model,
         ..Default::default()
@@ -446,9 +445,8 @@ fn run2d<F: fidget::eval::Function + fidget::render::RenderHints>(
             )),
             None => Some(fidget::render::ThreadPool::Global),
         };
-        let cfg = fidget::raster::ImageRenderConfig {
+        let cfg = fidget::raster::pixel::RenderConfig {
             image_size: fidget::render::ImageSize::from(settings.size),
-            tile_sizes: F::tile_sizes_2d(),
             threads: threads.as_ref(),
             pixel_perfect: matches!(mode, RenderMode2D::Sdf),
             world_to_model,

demos/viewer/src/draw3d.rs

@@ -3,7 +3,7 @@ use eframe::{
     egui,
     egui_wgpu::{self, wgpu},
 };
-use fidget::raster::GeometryPixel;
+use fidget::raster::voxel::GeometryPixel;
 use zerocopy::{Immutable, IntoBytes};
 
 /// Configuration for 3D rendering with geometry data

demos/viewer/src/main.rs

@@ -12,7 +12,10 @@ use notify::{Event, EventKind, Watcher};
 
 use fidget::{
     gui::{Canvas2, Canvas3, CursorState, DragMode, View2, View3},
-    raster::{GeometryPixel, ImageRenderConfig, VoxelRenderConfig},
+    raster::{
+        pixel::RenderConfig as ImageRenderConfig,
+        voxel::{GeometryPixel, RenderConfig as VoxelRenderConfig},
+    },
 };
 
 use std::{error::Error, path::Path};
@@ -174,7 +177,6 @@ fn render_2d<F: fidget::eval::Function + fidget::render::RenderHints>(
 ) -> Vec<[u8; 4]> {
     let config = ImageRenderConfig {
         image_size,
-        tile_sizes: F::tile_sizes_2d(),
         world_to_model: view.world_to_model(),
         pixel_perfect: matches!(mode, Mode2D::Sdf),
         ..Default::default()
@@ -208,7 +210,6 @@ fn render_3d<F: fidget::eval::Function + fidget::render::RenderHints>(
 ) -> Vec<GeometryPixel> {
     let config = VoxelRenderConfig {
         image_size,
-        tile_sizes: F::tile_sizes_3d(),
         world_to_model: view.world_to_model(),
         ..Default::default()
     };

demos/web-editor/crate/src/lib.rs

@@ -1,7 +1,7 @@
 use fidget::{
     context::{Context, Tree},
     gui::{Canvas2, Canvas3, DragMode, View2, View3},
-    raster::{GeometryBuffer, ImageRenderConfig, VoxelRenderConfig},
+    raster::{pixel, voxel},
     render::{CancelToken, ImageSize, ThreadPool, TileSizes, VoxelSize},
     var::Var,
     vm::{VmData, VmShape},
@@ -59,10 +59,10 @@ pub fn render_2d(
         view: View2,
         cancel: CancelToken,
     ) -> Option<Vec<u8>> {
-        let cfg = ImageRenderConfig {
+        let cfg = pixel::RenderConfig {
             image_size: ImageSize::from(image_size as u32),
             threads: Some(&ThreadPool::Global),
-            tile_sizes: TileSizes::new(&[64, 16, 8]).unwrap(),
+            tile_sizes: Some(TileSizes::new(&[64, 16, 8]).unwrap()),
             pixel_perfect: false,
             world_to_model: view.world_to_model(),
             cancel,
@@ -124,11 +124,11 @@ fn render_3d_inner(
     image_size: usize,
     view: View3,
     cancel: CancelToken,
-) -> Option<GeometryBuffer> {
-    let cfg = VoxelRenderConfig {
+) -> Option<voxel::Image> {
+    let cfg = voxel::RenderConfig {
         image_size: VoxelSize::from(image_size as u32),
         threads: Some(&ThreadPool::Global),
-        tile_sizes: TileSizes::new(&[128, 64, 32, 16, 8]).unwrap(),
+        tile_sizes: Some(TileSizes::new(&[128, 64, 32, 16, 8]).unwrap()),
         world_to_model: view.world_to_model(),
         cancel,
     };
@@ -251,6 +251,7 @@ pub struct JsCancelToken(CancelToken);
 
 #[wasm_bindgen]
 impl JsCancelToken {
+    #[expect(clippy::new_without_default)]
     #[wasm_bindgen(constructor)]
     pub fn new() -> Self {
         Self(CancelToken::new())
@@ -266,6 +267,9 @@ impl JsCancelToken {
         self.0.clone().into_raw()
     }
 
+    /// # Safety
+    /// The pointer must have been released by [`get_ptr`](Self::get_ptr), and
+    /// may only be claimed once.
     #[wasm_bindgen]
     pub unsafe fn from_ptr(ptr: *const std::sync::atomic::AtomicBool) -> Self {
         let token = unsafe { CancelToken::from_raw(ptr) };

fidget-core/src/render/config.rs

@@ -71,7 +71,7 @@ impl CancelToken {
     ///
     /// # Safety
     /// The pointer must have been previously returned by a call to
-    /// [`CancelToken::into_raw`].
+    /// [`CancelToken::into_raw`], and may only be reclaimed once.
     #[doc(hidden)]
     pub unsafe fn from_raw(ptr: *const AtomicBool) -> Self {
         let a = unsafe { Arc::from_raw(ptr) };