osgVerse

Introduction

osgVerse, a complete 3D engine solution based on OpenSceneGraph.

Operating System	Compiler	Supported	Notes
Windows 11	Visual Studio 2017-2022
Windows 10	Visual Studio 2017-2022
Windows 10	Visual Studio 2015		Requires VS2015 Update-3
Windows 10	MSYS2 (GCC 10.2)
Windows 10	Intel Compiler 2023		cmake -DCMAKE_C_COMPILER=icx -DCMAKE_CXX_COMPILER=icx -GNinja ..
Windows 10 UWP
Ubuntu 18.04	GCC 7.5 (or later)
Debian 11.7.0	GCC 10.2 (or later)
Kylin v10	GCC 8.3 (or later)		Set VERSE_FIND_LEGACY_OPENGL to ON
NeoKylin v7	GCC 8.5 (built manually)		Must disable VERSE_USE_GLIBCXX11_ABI
Mac OS X	14.4 or later
Android	Android Studio 2022+		Need to compile an example app
IOS
WebAssmebly	WSL + Emscripten 3.1.64		Supports GLES2 (WebGL1) and GLES3 (WebGL2)

Main Features (ongoing to v1.0)

• Supports from OSG 3.1.1 to the latest version, and GLSL 1.2 to 4.6, so to work with most hardware in the world.
• (PARTLY) Supports PBR-based rendering and deferred pipeline, with real-time shadowing and deferred lighting.
• (PARTLY) Supports physics simuation based on Bullet3/PhysX library, and character animation based on OZZ library.
• Supports complex model simplication, optimizing and tiling, and saving to OSGB format for better efficiency.
• Provides a LevelDB nosql plugin, for reading tiles from database rather than local folders.
• Provides a media streaming plugin, which supports pixel streaming through WebRTC / Websockets.
• Provides a scripting plugin, which supports scripting using OSGB serialization and changing to Restful-like format.
• Supports GL3 Core profile, as well as GLES2 / GLES3. Google Angel is also supported for future bridging uses.
• (PARTLY) Supports major desktop and mobile operating systems, including Windows, Linux, Mac OSX, Android and IOS.
• Supports major embedded devices with GPU supports, including ARM and RISC-V.
• Supports Emscripten / WASM compilation and works with WebGL 1/2 based browsers.
• Provides an initial visual scene editing tool, comparing with the famous Unity Editor.

Screenshots

• osgVerse_Viewer: PBR and deferred pipeline with Desktop GL
• osgVerse_ViewerWASM: PBR and deferred pipeline with WebGL 1.0, compiled from WASM
• osgVerse_JsCallerWASM: Scriptable osgb rendering with WebGL 1.0, compiled from WASM

Dependencies

1. Please use CMake 3.0 or higher version. (https://cmake.org/download/)
2. Please use a C++ compiler supporting C++ 14 at least.
3. OpenSceneGraph is always required for building osgVerse. (https://github.com/openscenegraph/OpenSceneGraph) Current project mainly depends on OSG 3.7.0, but can compile on OSG 3.1.1 or later versions.
4. Important (but optional) dependencies:

• 4.1 SDL2 (https://github.com/libsdl-org/SDL): for windowing system supports on Android, IOS and WebAssembly builds.
• 4.2 Google Angle (https://github.com/google/angle): for cross-Graphics API uses and Vulkan integrations.
• 4.3 Emscripten SDK (https://emscripten.org/docs/getting_started/downloads.html): for WebAssembly builds.
• 4.4 NVIDIA CUDA (https://developer.nvidia.com/cuda-downloads): for CUDA related functionalities.

5. Optional dependencies:

• 5.1 osgEarth 2.10.1 or later, for earth related applications and examples. (https://github.com/gwaldron/osgearth)
• 5.2 Bullet 3.17 or later, for physics support in osgVerseAnimation module and related examples. (https://github.com/bulletphysics/bullet3). Remember to enable INSTALL_LIBS (for correct installation) and USE_MSVC_RUNTIME_LIBRARY_DLL (for /MD flag) while compiling Bullet.
• 5.3 Entwine 2.0 or later, for EPT point cloud octree constructing. (https://github.com/connormanning/entwine)
• 5.4 Qt 5.5 or later, for Qt related applications and examples. (https://www.qt.io/licensing/open-source-lgpl-obligations)
• 5.5 ZLMediaKit (git version), for media streaming plugin. (https://github.com/ZLMediaKit/ZLMediaKit) Remember to uncheck the ENABLE_MSVC_MT option while compiling. To encode to H264 frame and pull to media server, you may also check ENABLE_X264 and add x264 (http://www.videolan.org/developers/x264.html) to ZLMediaKit.
• 5.6 OpenVDB 10.0 or later, for VDB point cloud and 3D image reader/writer plugin. (https://github.com/AcademySoftwareFoundation/openvdb)
• 5.7 libDraco 1.5 or later, for Draco mesh compression support in osgVerseReaderWriter library. (https://github.com/google/draco)
• 5.8 libIGL 2.5 or later, for Quadriflow, ManifoldPlus and other functionalities in osgModeling library. (https://github.com/libigl/libigl)
• 5.9 Vulkan 1.3 or later, for Vulkan extensions based on Google Angle's cross-Graphics API. (https://vulkan.lunarg.com/sdk/home)
• 5.10 Effekseer 1.70 or later, for particle support in osgVerseAnimation module and related examples. Remember to check the USE_MSVC_RUNTIME_LIBRARY_DLL option while compiling. (https://github.com/effekseer/Effekseer)
• 5.11 libCEF 127.3 or later, for HTML5/CSS page rendering support in osgVerseAnimation module and related examples. (Binaries download: https://cef-builds.spotifycdn.com/index.html)
• 5.12 mimalloc 2.17 or later, for general purpose memory allocator with excellent performance. (https://github.com/microsoft/mimalloc)
• 5.13 NVIDIA Video Codec SDK 12 or later, for video decoding/encoding based on codec_nv plugin. (https://developer.nvidia.com/video-codec-sdk)_

Supported Hardware

To use osgVerse libraries and applications, OpenGL version must be higher than 2.0. Both core profile and compatible profile will work. Our project uses the GLSL functionality, and supports from GLSL 120 to the latest GLSL version. Our project is already tested on graphics cards listed as below:

Graphics Card	OpenGL Version	Supported	Notes
NVIDIA RTX 30** Series	4.6 / GLSL 4.6
NVIDIA 10** Series	4.6 / GLSL 4.6
NVIDIA 1070 (Nouveau)	4.3 / GLSL 4.3		Display has broken problems with Nouveau driver
NVIDIA GT720	4.6 / GLSL 4.6		Current frame rate < 12fps
NVIDIA Quadro K2200	4.6 / GLSL 4.6
AMD Radeon RX5500	4.6 / GLSL 4.6
AMD Radeon (TM) Graphics	4.6 / GLSL 4.6		Current frame rate < 15fps
Intel UHD Graphics	4.6 / GLSL 4.6		Current frame rate ~= 30fps
MooreThreads S80, S2000	3.3 / GLSL 3.3		Enable VERSE_USE_MTT_DRIVER before solving driver problems
PhytiumVR AXT-16-512	3.0 / GLSL 3.3		Current frame rate < 10fps. Will go blank if GLSL code has '#include'... Why?
JingJia Micro JM7201
Zhaoxin C-960 (SIS)	3.2 / GLSL 1.5		Segment fault in osg::Texture at present
VirtualBox SVGA 3D	2.1 / GLSL 1.2		osgVerse_Test_Pipeline can work; standard can't

Modules

1. osgVerseDependency: contains all embedded 3rdparty dependencies.
2. osgVersePipeline: modern rendering pipeline supporting PBR materials, realtime shadows, deferred lighting and effects.
3. osgVerseReaderWriter: full featured reader-writer support for FBX, GLTF and KTX formats, and for more later.
4. osgVerseAnimation: physics and character animation supports.
5. osgVerseModeling: model simplification pipeline, modeling operators, and computational geometry utilities
6. osgVerseUI: IMGUI based quick UI support, HTML based UI solution, and related utilities.
7. osgVerseScript: Scripting support based on OSG serialization functionalities.
8. osgVerseAI: Artificial-Intelligence related classes, including navigation-mesh and so on.
9. osgVerseWrappers: All serialzier wrappers of osgVerse and extended OSG classes.
10. TBD...

Module dependency chain

Applications

1. osgVerse_SceneEditor: a forward-looking scene editor for osgVerse scene & components.
2. osgVerse_Viewer: a single-camera viewer with modern rendering pipeline support.
3. osgVerse_ViewerComposite: a multi-camera (multi-view) viewer with modern rendering pipeline support.
4. osgVerse_ViewerGLES: an example demostrating how to integrate osgVerse with SDL2, mainly with GLES2/3.
5. osgVerse_EarthViewer: an example demostrating how to integrate osgVerse with osgEarth.
6. osgVerse_QtViewer: an example demostrating how to integrate osgVerse with Qt.
7. osgVerse_ViewerWASM (wasm/pbr_demo): an example of WASM, with modern rendering pipeline support.
8. osgVerse_JsCallerWASM (wasm/script_demo): an example of WASM, demostrating how to use OSGB scripts with JS.
9. TBD...

Examples and Tests

1. osgVerse_Test_Plugins: a quick utility to show dependencies of a plugin library. (TBD: show depended and missing dlls)
2. osgVerse_Test_Pipeline: an example program for simple cases and compatiblity tests of osgVerse pipeline.
3. osgVerse_Test_Report_Graph: a quick utility to show scene graph information in details.
4. osgVerse_Test_Shader_Library: an example to make use of the shader library with OSG programs.
5. osgVerse_Test_Shadow: an example for shadow algorithm debugging and optimizing.
6. osgVerse_Test_Forward_Pbr: an example demostrating PBR rendering in single forwarded pass.
7. osgVerse_Test_ImGui: an example demostrating the use of IMGUI in osg scene. (TBD: multi-view IMGUI usage)
8. osgVerse_Test_Media_Stream: an example for media streaming / pixel streaming, including server and pusher implementation. (TBD: switch puller/player)
9. osgVerse_Test_Pbr_Prerequisite: a quick utility to pre-compute global PBR textures and save them to IBL osgb files.
10. osgVerse_Test_Paging_Lod: a quick utility for paged LOD file combination, optimization and transferring to levelDB.
11. osgVerse_Test_Point_Cloud: an example for point cloud viewing and manipulating. (TBD: eye-dome rendering)
12. osgVerse_Test_Player_Animation: an example of character animation loading and playing. (TBD: simple UI)
13. osgVerse_Test_Symbols: an example for drawing with Blend2D and displaying massive symbols with icons and texts.
14. osgVerse_Test_Tween_Animation: an example for tween animations, like path and data-driven animations. (TBD: time-out events)
15. osgVerse_Test_Polygon2D: an eample of 2D polygon operations. (TBD: labeling, spline usage, loading MVT)
16. osgVerse_Test_Mesh_Process: an example of 3D mesh operations. (TBD: labeling, topology, NURBS, common shapes)
17. osgVerse_Test_Navigation: an example of navmesh based navigation. (TBD: simple UI)
18. osgVerse_Test_Physics_Basic: a physics world example supporting rigid bodies & kinematics, requiring Bullet3.
19. osgVerse_Test_Particle_U3D: a Unity-like particle system example. (TBD: better fire/explosion example)
20. osgVerse_Test_Particle_Effekseer: another particle system example with Effekseer. (TBD: Effekseer scripting)
21. osgVerse_Test_Scripting: an example for scripting implementation based on OSGB serialization format.
22. osgVerse_Test_Video: an example for video demuxing, decoding and playing with multiple plugins.

Tests for specified goals

1. osgVerse_Test_Compressing: a test for KTX texture compression (DXT / ETC) and Draco geometry compressing.
2. osgVerse_Test_Thread: a test for using the Marl thread task scheduler along with osgViewer.
3. osgVerse_Test_Volume_Rendering: a test for different methods to implement volume rendering.
4. osgVerse_Test_Instance_Param: a test of comparing texture LUT and vertex-attrib divisor usages.
5. osgVerse_Test_Auto_LOD: a test of GeometryMerger usage: combination / indirect / octree.
6. osgVerse_Test_Sky_Box: a test of changable skybox and atmospheric scattering.
7. osgVerse_Test_Restful_Server: a test for restful HTTP API, which is based on libhv.
8. Deprecated tests:

• osgVerse_Test_FastRtt: a quick test for using newly-introduced RTT draw callback.
• osgVerse_Test_Obb_KDop: a quick test for creating a model's obb/kdop bounding volume.
• osgVerse_Test_CubeRtt: a quick test for render-to-cubemap (6 faces) demonstaration.
• osgVerse_Test_Mesh_Boolean: a quick test of mesh cutting with self-defined method.
• osgVerse_Test_Auto_Imposter: a quick test to change models to crossed billboards
• osgVerse_Test_Texture_Mapping: a test for GLSL texture tri-mapping implementation.
• osgVerse_Test_Indirect_Draw: a demo program to demonstrate how to use indirect drawing of OpenGL 4.x.
• osgVerse_Test_Tesselation: a demo program to demonstrate how to use tessellation shaders of OpenGL 4.x.
• osgVerse_Test_MultiView_Shader: a test for using geometry shader to implement multi-view rendering.

OSG-style Plugins

1. osgdb_verse_ept: a plugin for massive point cloud paging and rendering based on Entwine.
2. osgdb_verse_fbx: a plugin with full-featured FBX format support.
3. osgdb_verse_gltf: a plugin with full-featured GLTF & GLB format support.
4. osgdb_verse_web: a plugin for HTTP and more web protocols, which may replace the curl plugin.
5. osgdb_verse_image: a plugin for reading common image formats like JPEG and PNG. It mainly works for WASM case.
6. osgdb_verse_webp: a plugin for reading WEBP formats. It mainly works for 3dtiles scene.
7. osgdb_verse_leveldb: a plugin for reading/writing from LevelDB database.
8. osgdb_vese_tiles: a plugin for reading Cesium 3dtiles (.json) and Osgb files (metadata.xml, or just the root folder).
9. osgdb_verse_ms: a plugin for reading/writing from media streaming protocols like RTSP/RTMP/WebRTC.
10. osgdb_verse_ffmpeg: a plugin for video decoding/encoding with FFmpeg (enhanced to connect with codec_nv).
11. osgdb_codec_nv: a plugin for CUDA based video decoding/encoding support and connecting with demuxers/muxers and players.
12. osgdb_pbrlayout: a pseudo-plugin to change PBR textures' layout to osgVerse standard. It supports following options:

• Diffuse (D), Specular (S), Normal (N), Metallic (M), Roughness (R), Occlusion (O), Emissive (E), Ambient (A), Omitted (X)
• Every source texture is defined by a option character and a channel number (1-4), and separated with a ','.
• Example input: model.fbx.D4,M1R1X2,N3.pbrlayout (Tex0 = Diffuse x 4, Tex1 = Metallic+Roughness, Tex2 = Normal)
• All layouts will be converted to osgVerse standard: D4,N3,S4,O1R1M1,A3,E3

13. TBD...

Assets

1. models: 3D models for test use, mainly in GLTF format.
2. shaders: Shaders for osgVerse rendering pipeline use.
3. skyboxes: Skyboxes for test use, may be one HDR image or 6 cubemaps.
4. misc: Chinese IME CiKu files, font files, screenshots...
5. tests: Some test data

Prepare and build third-party libraries

1. By default, osgVerse will find third-party libraries as follows:

• OpenGL: from the system. Note that some Linux distributions (e.g., Qilin) should enable VERSE_FIND_LEGACY_OPENGL first.
• OpenSceneGraph: from environment variable $OSG_ROOT.
• SDL, Draco, Bullet, etc.: from CMake variable ${VERSE_3RDPARTY_PATH}, which is <osgverse_folder>/../Dependencies by default.
  • Actually path to find includes and libraries will be automatically set to '${VERSE_3RDPARTY_PATH}/'.
  • For x86/x64 build: is 'x86/x64'.
  • For Android build: is 'android'.
  • For MacOSX/IOS build: is 'apple/ios'.
  • For WebAssembly (WASM) build: is 'wasm'.
  • For Windows UWP build: is 'uwp'.

2. Build Draco:

• For WebAssembly (WASM):
  • export EMSCRIPTEN=<emsdk_folder>/upstream/emscripten
  • cmake -DCMAKE_TOOLCHAIN_FILE=$EMSCRIPTEN/cmake/Modules/Platform/Emscripten.cmake -DDRACO_WASM=ON -DDRACO_JS_GLUE=OFF -DCMAKE_INSTALL_PREFIX=<your_path>/Dependencies/wasm <draco_folder>
• See https://github.com/google/draco/blob/master/BUILDING.md for other platforms.

3. Build ZLMediaKit: TBD...
4. TBD...

Build from Source

0. Assume that osgVerse source code is already at <osgverse_folder>.
1. Desktop Windows / Linux

• Make sure you have a compiler environment (e.g., Visual Studio).
• Download and install CMake tool.
• Download OSG prebuilt libraries or build them from source, extracting to <osg_sdk_folder>.
• Declare an environment variable OSG_ROOT, to indicate OSG root directory:
  • (Windows) $ set OSG_ROOT=<osg_sdk_folder>
  • (Linux) $ export OSG_ROOT=<osg_sdk_folder>
• Run commands below in terminal:
  • $ cd <osgverse_folder>
  • $ mkdir build
  • $ cd build
  • $ cmake ..
  • $ cmake --build .
• You may also choose to use cmake-gui and set OSG related options in GUI mode.
• For MinGW build (UCRT64):
  • First download OpenSceneGraph prebuilt libraries:
    • $ pacman -S mingw-w64-ucrt-x86_64-OpenSceneGraph
  • Run commands below in terminal:
    • $ cmake -G "MSYS Makefiles" <osgverse_folder>
• For UWP build:
  • First download Windows Store SDK or latest Windows 11 SDK (with VS2022).
  • Download Angle for UWP: https://www.nuget.org/packages/ANGLE.WindowsStore
  • Rename the .nuget file to .zip and extract it. Find libraries and include files there.
  • Build OSG for GLES2/GLES3 (Desktop / GoogleAngle). See herlps/osg_builder/README.md for details.
  • Run commands below in terminal:
    • $ cmake -G "Visual Studio 17 2022" -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION="10.0" <osgverse_folder>

2. Desktop Mac OSX

• TBD...

3. Android

• TBD...

4. IOS

• TBD...

5. WebAssembly

• Download emsdk from https://emscripten.org/docs/getting_started/downloads.html, extracting to <emsdk_folder>.
• Update and activate emsdk as required at the page above.
• Build dependencies and save to <osgverse_folder>/../Dependencies/wasm
  • Build Draco (https://github.com/google/draco/blob/master/BUILDING.md)
    • $ export EMSCRIPTEN=<emsdk_folder>/upstream/emscripten
    • $ cmake ../ -DCMAKE_TOOLCHAIN_FILE=<emsdk_folder>/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake -DDRACO_WASM=ON -DDRACO_JS_GLUE=OFF -DCMAKE_INSTALL_PREFIX=<osgverse_folder>/../Dependencies/wasm
    • $ make install
  • Build GDAL, GEOS, etc. (https://github.com/bugra9/gdal3.js)
    • Modify GDAL_EMCC_FLAGS.mk to add '-pthread' to flags
    • $ sudo apt install automake sqlite3
    • $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
    • $ nvm install node
    • $ npm install -g pnpm@8.0
    • $ source <emsdk_folder>/emsdk_env.sh
    • $ pnpm install
    • $ pnpm run build
    • Copy bin/include/lib from gdal3.js\build\native\usr to <osgverse_folder>/../Dependencies/wasm
• Download OSG source code and extract it to <osgverse_folder>/../OpenSceneGraph
• (Optional) Download osgEarth-WASM source code and extract it to <osgverse_folder>/../osgearth-wasm
  • Repository: https://gitee.com/xarray/osgearth-wasm
  • osgEarth-WASM can only be built with WebGL 2.0
• Under Windows with Ninja:
  • Run commands below in terminal:
    • $ <emsdk_folder>/emsdk_env.bat
    • $ cd <osgverse_folder>
    • $ ./Setup.bat
• Under Linux or WSL (Windows Sub-System for Linux):
  • Start a UNIX ternimal (under Windows, please install WSL v1 and start it).
  • Run commands below in terminal:
    • $ cd <osgverse_folder>
    • $ ./Setup.sh <emsdk_folder>
• Select "3. WASM / WebGL 1.0" or "4. WASM / WebGL 2.0" and starting building WASM at <osgverse_folder>/build/verse_wasm.
• Start an HTTPS server at <osgverse_folder>/build/verse_wasm/bin. See <osgverse_folder>/wasm/run_webserver.py as an example.
• Copy <osgverse_folder>/assets to the same root folder of the server, and enjoy our WebGL examples.

CMake options