heitaoflower / vulkanscenegraph

Vulkan & C++17 based Scene Graph Project

VulkanSceneGraph (VSG), is a modern, cross platform, high performance scene graph library built upon Vulkan graphics/compute API. The software is written in C++17, and follows the CppCoreGuidlines and FOSS Best Practices. The source code is published under the MIT License.

The project aims to bring the performance of Vulkan to the wider developer community by providing a modern, high quality software library that is easy to use and focused on making the development of high performance graphics and compute applications a productive and fun experience.

This repository contains basic documentation, C++ headers and source and CMake build scripts to build the prototype libvsg library. Additional support libraries and examples are provided in separate repositories, links to these are provided below. The software currently builds under Linux, Windows, Android and macOS (using MoltenVk).

Public discussion list/forum

The VulkanSceneGraph Discussion Group vsg-users is the place for project news, discussions of latest developments and any questions you have on how to use the software in your applications. The discussion group can be read by anyone, to post to the group you'll need register.

Useful links in codebase and to associated projects

• Detailed build and install instructions
• Headers - the public interface : include/vsg/
• Source - the implementation : src/vsg/
• Tests & Examples - companion repository : https://github.com/vsg-dev/vsgExamples
• 3rd party image and model loaders - companion repository : https://github.com/vsg-dev/vsgXchange
• ImGui integration - companion repository : https://github.com/vsg-dev/vsgImGui
• Software development Road Map
• Design : Principles and Philosophy, High Level Decisions
• Community resources : Code of Conduct, Contributing guide
• Exploration Phase Materials (completed): Areas of Interest, 3rd Party Resources and Exploration Phase Report
• Prototype Phase Materials (completed): Workplan and Prototype Phase Report

---

Quick Guide to building the VSG

Prerequisites:

• C++17 compliant compiler i.e.. g++ 7.3 or later, Clang 6.0 or later, Visual Studio S2017 or later.
• Vulkan 1.1 or later.
• CMake 3.7 or later.

The above dependency versions are known to work so they've been set as the current minimum, it may be possible to build against older versions. If you find success with older versions let us know and we can update the version info.

Download VulkanSDK from LunarG, unpack into local directory and set VUKAN_SDK environemt variable to the include/lib directory within it. For Linux it would tyically be along the lines of:

export VULKAN_SDK_VERSION=1.2.162.1
export VULKAN_SDK=${PWD}/VulkanSDK/${VULKAN_SDK_VERSION}/x86_64

mkdir VulkanSDK
wget https://sdk.lunarg.com/sdk/download/${VULKAN_SDK_VERSION}/linux/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz -O VulkanSDK/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz
tar zxf VulkanSDK/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz -C VulkanSDK/

Once you've downloaded and unpacked the VulkanSDK you'll want to put VULKAN_SDK into your user environemt variable setup so that CMake's find_package(Vulkan) can find the VulkanSDK's location.

Command line build instructions:

To build and install the static libvsg library (.a/.lib) in source:

git clone https://github.com/vsg-dev/VulkanSceneGraph.git
cd VulkanSceneGraph
cmake .
make -j 8
sudo make install

Full details on how to build of the VSG (Unix/Windows/Android/macOS) can be found in the INSTALL.md file.

---

Examples of the VSG in use

It's still very early days for the project so we don't have many projects that use to the VSG to reference, for our own testing purposes we have two project which may serve as an illustration of how to compile against the VSG and how to use parts of it's API. These projects are:

• MyFirstVsgApplication simple standalone VSG application that can be used as a template for your own applications.
• vsgExamples set of example programs that we are using to test out VSG functionality and illustrates usage.
• vsgXchange utility library that adds suport for reading/writing files from 3rd party source. Includes GLSL shader compilation to SPIR-V. When OpenSceneGraph is available support for all model or image formats supported by the OpenSceneGraph are available. Provides vsgconv utility for converting different file types - mdoels, images, shaders to VSG native formats. The vsgviewer and MyFrstVsgApplication examples also automatically add support for reading files from vsgXchange when they area built with vsgXchange avaulable.
• vsgUnity is a plugin for the Unity Editor allowing you create export models directly into native VSG format.

Two examples within the vsgExamples project that may be of particular interest are ports of Vulkan tutorials to the VSG API. In each case the VSG version requires less than 1/5th the amount of code to achieve the same functionality.

• Vulkan Tutorial ported as vsgExamples/commands/vsgdraw
• vulkan_minimal_compute tutorial ported to VSG vsgExamples/vk/vsgcompute