ssbh_wgpu is a lightweight and portable Smash Ultimate model and texture renderer built using WGPU.
Add the following lines to the Cargo.toml. This library is still highly experimental. Specify the commit tag or commit the Cargo.lock file to version control to avoid any versioning issues. For an example of an application using this renderer, see ssbh_editor.
ssbh_wgpu = { git = "https://github.com/ScanMountGoat/ssbh_wgpu", rev = "hash" }
nutexb_wgpu = { git = "https://github.com/ScanMountGoat/ssbh_wgpu", rev = "hash" }
- nutexb_wgpu -- texture renderer and library for converting nutexb files to WGPU textures
- nutexb_wgpu_viewer -- simple winit application for viewing nutexb textures
- ssbh_wgpu -- model and animation rendering library. Converts ssbh_data types to WGPU types.
- ssbh_wgpu_test -- windowless program for testing model loading
- ssbh_wgpu_viewer -- simple winit application for viewing models and animations
With a recent verison of the Rust toolchain installed, run cargo build --release. Don't forget the --release since debug builds have very low framerates!
Implementations are based on data from testing the output of the emulators Yuzu and Ryujinx using the RenderDoc debugger. Most testing is done by running a modified build of Ryujinx running OpenGL on the latest version of RenderDoc. The modified build comments out usages of functions not supported by RenderDoc like GL.AlphaFunc to fix compatibility issues preventing captures. The OpenGL API can have worse performance than Vulkan but allows for editing shaders in RenderDoc. The shaders use the same format as the decompiled shaders found in Smush-Material-Research. Converting the memory layout of Switch textures to a usable layout is handled by tegra_swizzle, which was also tested using RenderDoc and Ryujinx. Although the WGPU library is more similar to Vulkan or DX12 in terms of design, mapping OpenGL calls in RenderDoc to WGPU is generally straightforward. This approach also avoids the need to reverse engineer any graphis APIs specific to the Switch hardware. Creating a perfect 1:1 recreation of the Smash Ultimate rendering engine is not a goal of this project, so debugging the emulators primarily serves as a way to validate parts of this implementation and debug any relevant differences with in game rendering.
When submitting code, run cargo fmt for Rust files and format using wgsl_analyzer for WGSL files.
ssbh_wgpu is a continuation of the rendering work done for CrossMod. File formats are handled by ssbh_data, nutexb, and prc-rs.