Skip to content

We present the first open-source VR NERF Unity package that brings high resolution, low-latency, 6-DOF NERF rendering to VR. This work is based on Nvidia's ground breaking instant-ngp technique.

License

Notifications You must be signed in to change notification settings

IxxyXR/immersive-ngp

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Immersive Neural Graphics Primitives

In this project, we present immersive NGP, the first open-source VR NERF Unity package that brings high resolution, low-latency, 6-DOF NERF rendering to VR. This work is based on Nvidia's ground breaking instant-ngp technique. Current version uses this commit of instant-ngp.

Features

  • Stereoscopic, 6-DOF, real-time, low-latency NERF VR rendering in Unity. plugin-files.PNG

  • DLSS Support for rendering at higher framerate.

  • 6-DOF continuous locomotion in VR.

  • Offline volume image slices rendering via Unity Volume Rendering Toolkit.

  • Integration with MRTK 2.8 for building mixed reality applications with NERF.

    • Example: Merging a NERF volume image slices with a CAD model

      plugin-files.PNG

Dependencies

  • Unity 2019.4.29 ( Use the legacy XR manager for compatibility with OpenVR)
  • instant-ngp
  • Unity OpenVR desktop plugin && SteamVR
  • Microsoft Mixed Reality Toolkit MRTK 2.8
  • OpenGL Graphics API
  • Current version of the repository was tested on Windows 10, and Oculus Quest 2.

Installation

  1. Clone this repository: git clone --recursive https://github.com/uhhhci/immersive-ngp

  2. Make sure you have all the dependencies for instant-ngp installed before proceed.

  3. Update dependencies for submodules

    git submodule sync --recursive
    git submodule update --init --recursive
    
  4. Build the instant-ngp project, similar to the build process for the original instant-ngp project.

    cmake . -B build
    cmake --build build --config RelWithDebInfo -j
    
  5. After succesful build, copy the following plugin files from \instant-ngp\build\ folder to the \stereo-nerf-unity\Assets\Plugins\x86_64 folder.

    plugin-files.PNG

  6. Now instant-ngp can be loaded as native plugins via Unity.

Usage for Immersive NERF Rendering

  1. Open the stereo-nerf-unity Unity project with Unity 2019.4.29.

  2. For a quick VR test of your own NERF scene, go to the Assets\NERF_NativeRendering\Scenes\XRTest scene.

  3. Copy the path to your nerf model, images folder, and transform.json file to the Stereo Nerf Renderer in the Nerf path parameters, as ilustrated below.

    .\images\stereo-nerf-gameobj.PNG

  4. Adjust DLSS settings, and image resolution as you like.

  5. Now you can run the scene in Editor :)

  6. Use the joystick of the VR controllers for locomotion.

  7. Disclaimer: There is currently an issue with running the scene in Unity Editor with native plugin clean up, you might need to restart the editor when running a new scene.

Common Questions & Troubleshoot

  1. How to reach good framerate and lower latency

    Beside having a good GPU, it is highly recommended to turn on DLSS support in Unity, also when building the native plugin.

    The instant-ngp commit we use also allows saving aabb cropping in the pre-trained model snapshot. If you adjust the aabb cropping when training the model, it will saved and be loaded in Unity as well. Reducing aabb cropping could reduce the render volume, thus save some computational power.

  2. Locomotion doesn't work

    Make sure that SteamVR detects both of your controllers before starting the scenes in the Editors.

Roadmap

  • Fix Editor restart issue
  • Time-warp algorithm for latency compensation
  • Dynamics Resolution
  • Foveated NERF
  • Support for OpenXR
  • Support for higher Unity Version
  • Real-time SLAM capture for dynamic grow dataset

Thanks

Many thanks to the authors of these open-source repositories:

  1. instant-ngp
  2. Unity Volume Rendering
  3. Mixed Reality Toolkit
  4. Unity Native Plugin Reloader

Authors

*Ke Li1, 2, * Tim Rolff1,3, Susanne Schmidt 1, Reinhard Bacher 2 , Simone Frintrop 3 , Wim Leemans 3 , Frank Steinicke 1

*These authors contributed equally to the work.

1 Human-Computer Interaction Group, Department of Informatics, Universität Hamburg

2 Deutsches Elektronen-Synchrotron DESY, Germany

3 Computer Vision Group, Department of Informatics, Universität Hamburg

Contact: [email protected], [email protected]

Citations

@misc{Immersive-NGP,
  author = {Tim Rolff and Ke Li and Susanne Schmidt and Reinhard Bacher and   Simone Frintrop and Wim Leemans and Frank Steinicke},
  title = {Immersive Neural Graphics Primitives},
  year = {2022},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/uhhhci/Immersive-Neural-Graphics-Primitives}},
}

Acknowledgment

This work was supported by DASHH (Data Science in Hamburg - HELMHOLTZ Graduate School for the Structure of Matter) with the Grant-No. HIDSS-0002, and the German Federal Ministry of Education and Research (BMBF).

License

Please check here to view a copy of Nvidia's license for instant-ngp and for this repository.

About

We present the first open-source VR NERF Unity package that brings high resolution, low-latency, 6-DOF NERF rendering to VR. This work is based on Nvidia's ground breaking instant-ngp technique.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 41.3%
  • C++ 26.4%
  • Cuda 15.5%
  • C# 7.5%
  • ShaderLab 5.2%
  • Python 2.4%
  • Other 1.7%