Skip to content

Latest commit

 

History

History
224 lines (212 loc) · 17.5 KB

README.md

File metadata and controls

224 lines (212 loc) · 17.5 KB
Raw

Image

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 🔜
Android WSL + NDK r20e (Clang) ✔️
IOS 🔜
WebAssmebly WSL + Emscripten 3.1.44 ✔️ Supports GLES2 (WebGL1) at present

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.
  • Supports physics simuation based on Bullet3 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.
  • (PARTLY) 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 Image
  • osgVerse_ViewerWASM: PBR and deferred pipeline with WebGL 1.0, compiled from WASM Image
  • osgVerse_JsCallerWASM: Scriptable osgb rendering with WebGL 1.0, compiled from WASM Image

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 dependencies:
  1. Optional dependencies:

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 🔜
NVIDIA Quadro K2200 🔜
AMD Radeon RX5500 🔜
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
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. osgVersePipeline: modern rendering pipeline supporting PBR materials, realtime shadows, deferred lighting and effects.
  2. osgVerseReaderWriter: full featured reader-writer support for FBX, GLTF and KTX formats, and for more later.
  3. osgVerseAnimation: physics and character animation supports.
  4. osgVerseModeling: model simplification pipeline, modeling operators, and computational geometry utilities
  5. osgVerseUI: IMGUI based quick UI support, HTML based UI solution, and related utilities.
  6. osgVerseScript: Scripting support based on OSG serialization functionalities.
  7. TBD...

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...

Tests and Examples

  1. osgVerse_Test_ImGui: a quick test for demostrating the use of IMGUI in osg scene.
  2. osgVerse_Test_Mesh_Process: a mesh process and topology builder example.
  3. osgVerse_Test_Physics_Basic: a physics world example supporting rigid bodies & kinematics, requiring Bullet3.
  4. osgVerse_Test_Shadow: a test for shadow algorithm debugging and optimizing.
  5. osgVerse_Test_Pipeline: a program for simple cases and compatiblity tests of osgVerse pipeline.
  6. osgVerse_Test_Pbr_Prerequisite: a quick utility to pre-compute global PBR textures and save them to IBL osgb files.
  7. osgVerse_Test_Paging_Lod: a test for paged LOD file combination, optimization and transferring to levelDB.
  8. osgVerse_Test_Point_Cloud: a test for point cloud viewing and manipulating.
  9. osgVerse_Test_Media_Stream: a test for media streaming / pixel streaming, including server and pusher implementation.
  10. osgVerse_Test_Restful_Server: a test for restful HTTP API, which is based on libhv.
  11. osgVerse_Test_Scripting: a test for scripting implementation based on OSGB serialization format.
  12. osgVerse_Test_Compressing: a test for KTX texture compression (DXT / ETC) and Draco geometry compressing.
  13. osgVerse_Test_Thread: a test for using the Marl thread task scheduler along with osgViewer.
  14. osgVerse_Test_Volume_Rendering: a test for different methods to implement volume rendering.
  15. osgVerse_Test_MultiView_Shader: a test for using geometry shader to implement multi-view rendering.
  16. 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_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.
  1. TBD...

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_leveldb: a plugin for reading/writing from LevelDB database.
  7. osgdb_verse_ms: a plugin for reading/writing from media streaming protocols like RTSP/RTMP/WebRTC.
  8. osgdb_verse_tiff: a plugin for reading/writing TIFF files, which supports 2D/3D tiff files.
  9. osgdb_verse_osgparticle: a plugin to wrap osgParticle classes for use in scene editor, mainly as an example for custom extensions.
  10. 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
  1. 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

Build from Source

  1. Assume that osgVerse source code is already at <osgverse_folder>.
  2. 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 UWP build:
    • First download Windows Store SDk or latest Windows 11 SDK (with VS2022).
    • Run commands below in terminal:
      • $ cmake -G "Visual Studio 17 2022" -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION="10.0" ..
  1. Desktop Mac OSX
  • TBD...
  1. Android
  • TBD...
  1. IOS
  • TBD...
  1. 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.
  • Download OSG source code and extract it to <osgverse_folder>/../OpenSceneGraph.
  • 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 / OpenGL ES2" 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

Option Type Default Value Notes
OSG_INCLUDE_DIR Path (Required) Set to path of osg/Node
OSG_BUILD_INCLUDE_DIR Path (Required) Set to path of osg/Version
OSG_LIB_DIR Path (Required) Set to path of libosg.a or osg.lib
OSG_DEBUG_POSTFIX String d Set a postfix for OSG debug built-libraries
OSG_GLES_INCLUDE_DIR Path Set to path of GLES2/gl2.h or GLES3/gl3.h, for GLES build only
OSG_GLES_LIBRARY Path Set to path of libGLESv2.so or libGLESv2.lib, for GLES build only
OSG_EGL_LIBRARY Path Set to path of libEGL.so or libEGL.lib, for GLES build only
BULLET_INCLUDE_DIR Path Set to path of btBulletDynamicsCommon.h
BULLET_LIB_DIR Path Set to path of libBulletDynamics.a or BulletDynamics.lib
BULLET_DEBUG_POSTFIX String _Debug Set a postfix for Bullet debug built-libraries
ZLMEDIAKIT_INCLUDE_DIR Path Set to path of mk_common.h
ZLMEDIAKIT_LIB_DIR Path Set to path of libmk_api.so or mk_api.lib
OPENVDB_INCLUDE_DIR Path Set to path of openvdb/openvdb.h
OPENVDB_BOOST_INCLUDE_DIR Path Set to path of boost/type.hpp
OPENVDB_TBB_INCLUDE_DIR Path Set to path of tbb/blocked_range.h
OPENVDB_LIB_DIR Path Set to path of libopenvdb.so or openvdb.lib
OPENVDB_TBB_LIB_DIR Path Set to path of libtbb.so or tbb.lib
OSGEARTH_INCLUDE_DIR Path Set to path of osgEarth/EarthManipulator
OSGEARTH_BUILD_INCLUDE_DIR Path Set to path of osgEarth/BuildConfig
OSGEARTH_LIB_DIR Path Set to path of libosgEarth.so or osgEarth.lib
SDL2_INCLUDE_DIR Path Set to path of SDL.h
SDL2_LIB_DIR Path Set to path of libSDL2.so or SDL2.lib
Qt5_DIR Path Set to path of <qt_dist>/lib/cmake/Qt5
Qt6_DIR Path Set to path of <qt_dist>/lib/cmake/Qt6
VERSE_BUILD_GPL Boolean OFF Enable build of GPL dependencies (e.g., mcut), which will makes osgVerse a GPL library
VERSE_BUILD_3RDPARTIES Boolean ON Enable build of common libraries like FreeType, Jpeg, PNG and Tiff
VERSE_BUILD_WITH_QT Boolean OFF Enable build of Qt based applications and tests
VERSE_BUILD_DEPRECATED_TESTS Boolean OFF Enable build of deprecated tests
VERSE_SUPPORT_CPP17 Boolean OFF Enable build of libraries using C++ 17 standard
VERSE_STATIC_BUILD Boolean OFF Enable static build of osgVerse
VERSE_USE_OSG_STATIC Boolean OFF Use static build of OpenSceneGraph (will force osgVerse to be static)
VERSE_USE_DWARF Boolean OFF Enable detailed debug-info and symbols. 'libdw-dev' must be installed
VERSE_USE_GLIBCXX11_ABI Boolean ON Enable to use libraries built with GCC compiler newer than 4.9
VERSE_USE_MTT_DRIVER Boolean OFF Enable to use MooreThreads MTT drivers correctly
VERSE_USE_FORCED_MULTIPLE Boolean OFF Enable to solve LNK2005 problem when compiling OSG 3.2 and lower under MSVC
VERSE_WASM_USE_PTHREAD Boolean ON Enable Pthread for WASM, which requires COOP / COEP on server-side, for WASM build only
VERSE_FIND_LEGACY_OPENGL Boolean OFF Enable to use legacy mode to search OpenGL libraries, for some Linux systems like Kylin