Skip to content

LioQing/wgpu-3dgs-viewer-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

...written in Rust using wgpu and egui.

Github Pages CI License

Getting started

This viewer app is built for 3D Gaussian Splatting. It supports the PLY file format from the 3D Gaussian Splatting for Real-Time Radiance Field Rendering research paper.

Note

The core of this app is a rendering crate for 3D Gaussian splatting, wgpu-3dgs-viewer! The crate uses wgpu, the Rust implementation of WebGPU, to render the model, so it supports most of the GPU backends.

Running the app

Web

You can run the app on the web by visiting https://lioqing.com/wgpu-3dgs-viewer-app/.

Note

To use the web version, you need a browser that supports WebGPU. Please refer to the WebGPU Implementation Status for more information.

Warning

Apple Silicon is found to crash when trying to render models in the web version, use the native version instead.

Native

You can run the app natively, by downloading from the latest release from the releases page depending on your operating system.

Features

  • Load large PLY files at very fast speed.
  • Different Gaussian display modes.
  • Render multiple models at once.
  • Edit the model's transform and colors.
  • Mask the model with composite shapes.

Demo

The following demos are recorded on laptop with:

  • CPU: AMD Ryzen 9 4900HS
  • GPU: NVIDIA GeForce RTX 2060 with Max-Q Design
  • RAM: 32 GB

Compression & Loading

Models are compressed and loaded while being streamed from the file at a very fast speed.

Compression.Loading.mp4

Display Mode

Gaussians can be viewed as ellipses or points, with specified spherical harmonic degrees, and at different sizes.

Display.Mode.mp4

Multiple Models

Multiple models can be loaded to be viewed in the same scene.

Multiple.Models.mp4

Selection & Editing

Gaussians can be selected using various tools and be used for color editing.

Selection.Editing.mp4

Composite Mask

Masks can be used to select Gaussians to view, which can be composed using set operations.

Masks.mp4

Development

Native

Make sure you are using the latest version of stable rust by running rustup update.

cargo run --release

On Linux you need to first run:

sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev

On Fedora Rawhide you need to run:

dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel

Web locally

We compile to WASM and use Trunk to build for web target.

  1. Install the required target with rustup target add wasm32-unknown-unknown.
  2. Install Trunk with cargo install --locked trunk.
  3. Run trunk serve to build and serve on http://127.0.0.1:8080. Trunk will rebuild automatically if you edit the project.
  4. Open http://127.0.0.1:8080/index.html#dev in a browser. See the warning below.

Note

assets/sw.js script will try to cache our app, and loads the cached version when it cannot connect to server allowing your app to work offline (like PWA). appending #dev to index.html will skip this caching, allowing us to load the latest builds during development.

About

A 3D Gaussian Splatting Viewer App written in Rust using wgpu and egui.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Languages