feat: msaa toggle (#77)

* feat: msaa config * docs: style * chore: clippy warnings fail ci * fix: lint errors * feat: viewer screenshots * fix: bevy screenshots require multi-threaded feature * fix: log screenshot confirmation * docs: more relevant landing image * fix: web build * docs: use webp image format * chore: more parallel ci
mosure · Jan 20, 2024 · 4d855c3 · 4d855c3
1 parent 678dab5
commit 4d855c3
Show file tree

Hide file tree

Showing 14 changed files with 208 additions and 74 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,61 @@
+name: build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+        rust-toolchain:
+          - nightly
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 120
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup ${{ matrix.rust-toolchain }} rust toolchain with caching
+      uses: brndnmtthws/rust-action@v1
+      with:
+        toolchain: ${{ matrix.rust-toolchain }}
+        components: rustfmt, clippy
+        enable-sccache: "true"
+
+    - name: build
+      run: cargo build
+
+
+  build_tools:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+        rust-toolchain:
+          - nightly
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 120
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup ${{ matrix.rust-toolchain }} rust toolchain with caching
+      uses: brndnmtthws/rust-action@v1
+      with:
+        toolchain: ${{ matrix.rust-toolchain }}
+        components: rustfmt, clippy
+        enable-sccache: "true"
+
+    - name: build_tools
+      run: cargo build --bin ply_to_gcloud
diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml
@@ -0,0 +1,37 @@
+name: clippy
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+jobs:
+  clippy:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+        rust-toolchain:
+          - nightly
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 120
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup ${{ matrix.rust-toolchain }} rust toolchain with caching
+      uses: brndnmtthws/rust-action@v1
+      with:
+        toolchain: ${{ matrix.rust-toolchain }}
+        components: rustfmt, clippy
+        enable-sccache: "true"
+
+    - name: lint
+      run: cargo clippy -- -Dwarnings
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -11,7 +11,7 @@ env:
   RUST_BACKTRACE: 1
 
 jobs:
-  build:
+  test:
 
     strategy:
       fail-fast: false
@@ -33,26 +33,30 @@ jobs:
         components: rustfmt, clippy
         enable-sccache: "true"
 
-    - name: build
-      run: cargo build
-
-    - name: build_tools
-      run: cargo build --bin ply_to_gcloud
-
-    - name: lint
-      run: cargo clippy
-
     - name: test (default)
       run: cargo test
 
-    - name: test (web)
-      run: cargo test --no-default-features --features="web io_ply tooling"
 
-    # - name: gaussian render test
-    #   run: cargo run --bin test_gaussian
+  test_web:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+        rust-toolchain:
+          - nightly
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 120
 
-    # - name: radix sort test
-    #   run: cargo run --bin test_radix --features="debug_gpu"
+    steps:
+    - uses: actions/checkout@v3
 
+    - name: Setup ${{ matrix.rust-toolchain }} rust toolchain with caching
+      uses: brndnmtthws/rust-action@v1
+      with:
+        toolchain: ${{ matrix.rust-toolchain }}
+        components: rustfmt, clippy
+        enable-sccache: "true"
 
-    # TODO: test wasm build, deploy, and run
+    - name: test (web)
+      run: cargo test --no-default-features --features="web io_ply tooling"
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ Cargo.lock
 .DS_Store
 
 www/assets/
+screenshots/
diff --git a/Cargo.toml b/Cargo.toml
@@ -101,6 +101,7 @@ viewer = [
   "bevy-inspector-egui",
   "bevy_panorbit_camera",
   # "bevy_transform_gizmo",
+  "bevy/multi-threaded",  # bevy screenshot functionality requires bevy/multi-threaded as of 0.12.1
 ]
 
 web = [

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 bevy gaussian splatting render pipeline plugin. view the [live demo](https://mosure.github.io/bevy_gaussian_splatting/index.html?arg1=cactus.gcloud)
 
-![Alt text](docs/notferris.png)
+![Alt text](docs/bevy_gaussian_splatting_demo.webp)
 ![Alt text](docs/go.gif)
 
 
@@ -76,7 +76,7 @@ fn setup_gaussian_cloud(
 | `0.4 - 1.0`               | `0.12` |
 | `0.1 - 0.3`               | `0.11` |
 
-## Projects using this plugin
+## projects using this plugin
 - [kitt2](https://github.com/cs50victor/kitt2)
 
 # credits

diff --git a/docs/bevy_gaussian_splatting_demo.webp b/docs/bevy_gaussian_splatting_demo.webp
diff --git a/src/gaussian/cloud.rs b/src/gaussian/cloud.rs
@@ -429,7 +429,7 @@ impl GaussianCloud {
                 coefficients: {
                     #[cfg(feature = "f16")]
                     {
-                        let mut coefficients = [0 as u32; HALF_SH_COEFF_COUNT];
+                        let mut coefficients = [0_u32; HALF_SH_COEFF_COUNT];
 
                         for coefficient in coefficients.iter_mut() {
                             let upper = rng.gen_range(-1.0..1.0);

diff --git a/src/render/mod.rs b/src/render/mod.rs
@@ -78,7 +78,7 @@ use crate::{
 #[cfg(feature = "packed")]
 mod packed;
 
-#[cfg(all(feature = "buffer_storage"))]
+#[cfg(feature = "buffer_storage")]
 mod planar;
 
 #[cfg(feature = "buffer_texture")]
@@ -231,17 +231,34 @@ impl RenderAsset for GaussianCloud {
             count,
             draw_indirect_buffer,
 
-            #[cfg(feature = "debug_gpu")]
-            debug_gpu: gaussian_cloud,
-
             #[cfg(feature = "packed")]
             packed: packed::prepare_cloud(render_device, &gaussian_cloud),
             #[cfg(feature = "buffer_storage")]
             planar: planar::prepare_cloud(render_device, &gaussian_cloud),
+
+            #[cfg(feature = "debug_gpu")]
+            debug_gpu: gaussian_cloud,
         })
     }
 }
 
+#[cfg(feature = "buffer_storage")]
+type GpuGaussianBundleQuery = (
+    Entity,
+    &'static Handle<GaussianCloud>,
+    &'static Handle<SortedEntries>,
+    &'static GaussianCloudSettings,
+    (),
+);
+
+#[cfg(feature = "buffer_texture")]
+type GpuGaussianBundleQuery = (
+    Entity,
+    &'static Handle<GaussianCloud>,
+    &'static Handle<SortedEntries>,
+    &'static GaussianCloudSettings,
+    &'static texture::GpuTextureBuffers,
+);
 
 #[allow(clippy::too_many_arguments)]
 fn queue_gaussians(
@@ -256,23 +273,8 @@ fn queue_gaussians(
         &ExtractedView,
         &mut RenderPhase<Transparent3d>,
     )>,
-
-    #[cfg(feature = "buffer_storage")]
-    gaussian_splatting_bundles: Query<(
-        Entity,
-        &Handle<GaussianCloud>,
-        &Handle<SortedEntries>,
-        &GaussianCloudSettings,
-        (),
-    )>,
-    #[cfg(feature = "buffer_texture")]
-    gaussian_splatting_bundles: Query<(
-        Entity,
-        &Handle<GaussianCloud>,
-        &Handle<SortedEntries>,
-        &GaussianCloudSettings,
-        &texture::GpuTextureBuffers,
-    )>,
+    msaa: Res<Msaa>,
+    gaussian_splatting_bundles: Query<GpuGaussianBundleQuery>,
 ) {
     // TODO: condition this system based on GaussianCloudBindGroup attachment
     if gaussian_cloud_uniform.buffer().is_none() {
@@ -305,6 +307,7 @@ fn queue_gaussians(
                 visualize_bounding_box: settings.visualize_bounding_box,
                 visualize_depth: settings.visualize_depth,
                 draw_mode: settings.draw_mode,
+                sample_count: msaa.samples(),
             };
 
             let pipeline = pipelines.specialize(&pipeline_cache, &custom_pipeline, key);
@@ -327,8 +330,6 @@ fn queue_gaussians(
 }
 
 
-
-
 #[derive(Resource)]
 pub struct GaussianCloudPipeline {
     shader: Handle<Shader>,
@@ -392,9 +393,9 @@ impl FromWorld for GaussianCloudPipeline {
         let read_only = false;
 
         #[cfg(feature = "packed")]
-        let gaussian_cloud_layout = packed::get_bind_group_layout(&render_device, read_only);
+        let gaussian_cloud_layout = packed::get_bind_group_layout(render_device, read_only);
         #[cfg(all(feature = "buffer_storage", not(feature = "packed")))]
-        let gaussian_cloud_layout = planar::get_bind_group_layout(&render_device, read_only);
+        let gaussian_cloud_layout = planar::get_bind_group_layout(render_device, read_only);
         #[cfg(feature = "buffer_texture")]
         let gaussian_cloud_layout = texture::get_bind_group_layout(&render_device, read_only);
 
@@ -575,6 +576,7 @@ pub struct GaussianCloudPipelineKey {
     pub visualize_bounding_box: bool,
     pub visualize_depth: bool,
     pub draw_mode: GaussianCloudDrawMode,
+    pub sample_count: u32,
 }
 
 impl SpecializedRenderPipeline for GaussianCloudPipeline {
@@ -633,7 +635,7 @@ impl SpecializedRenderPipeline for GaussianCloudPipeline {
                 },
             }),
             multisample: MultisampleState {
-                count: 4,  // TODO: disable MSAA for gaussian pipeline
+                count: key.sample_count,
                 mask: !0,
                 alpha_to_coverage_enabled: false,
             },
@@ -741,20 +743,7 @@ fn queue_gaussian_bind_group(
     asset_server: Res<AssetServer>,
     gaussian_cloud_res: Res<RenderAssets<GaussianCloud>>,
     sorted_entries_res: Res<RenderAssets<SortedEntries>>,
-
-    #[cfg(feature = "buffer_storage")]
-    gaussian_clouds: Query<(
-        Entity,
-        &Handle<GaussianCloud>,
-        &Handle<SortedEntries>,
-    )>,
-    #[cfg(feature = "buffer_texture")]
-    gaussian_clouds: Query<(
-        Entity,
-        &Handle<GaussianCloud>,
-        &Handle<SortedEntries>,
-        &texture::GpuTextureBuffers,
-    )>,
+    gaussian_clouds: Query<GpuGaussianBundleQuery>,
 
     #[cfg(feature = "buffer_texture")]
     gpu_images: Res<RenderAssets<Image>>,
@@ -785,7 +774,7 @@ fn queue_gaussian_bind_group(
         let sorted_entries_handle = query.2;
 
         #[cfg(feature = "buffer_texture")]
-        let texture_buffers = query.3;
+        let texture_buffers = query.4;
 
         // TODO: add asset loading indicator (and maybe streamed loading)
         if Some(LoadState::Loading) == asset_server.get_load_state(cloud_handle){
@@ -810,9 +799,9 @@ fn queue_gaussian_bind_group(
         let sorted_entries = sorted_entries_res.get(sorted_entries_handle).unwrap();
 
         #[cfg(feature = "packed")]
-        let cloud_bind_group = packed::get_bind_group(&render_device, &gaussian_cloud_pipeline, &cloud);
+        let cloud_bind_group = packed::get_bind_group(&render_device, &gaussian_cloud_pipeline, cloud);
         #[cfg(all(feature = "buffer_storage", not(feature = "packed")))]
-        let cloud_bind_group = planar::get_bind_group(&render_device, &gaussian_cloud_pipeline, &cloud);
+        let cloud_bind_group = planar::get_bind_group(&render_device, &gaussian_cloud_pipeline, cloud);
         #[cfg(feature = "buffer_texture")]
         let cloud_bind_group = texture_buffers.bind_group.clone();
 

diff --git a/src/sort/rayon.rs b/src/sort/rayon.rs
@@ -25,6 +25,7 @@ impl Plugin for RayonSortPlugin {
     }
 }
 
+#[allow(clippy::too_many_arguments)]
 pub fn rayon_sort(
     asset_server: Res<AssetServer>,
     gaussian_clouds_res: Res<Assets<GaussianCloud>>,
@@ -67,10 +68,8 @@ pub fn rayon_sort(
 
         if camera_movement {
             *sort_done = false;
-        } else {
-            if *sort_done {
-                return;
-            }
+        } else if *sort_done {
+            return;
         }
 
         *last_camera_position = camera_position;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,3 +14,4 @@ Cargo.lock
		.DS_Store

		www/assets/
		screenshots/