Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/KTStephano/StratusGFX

Realtime 3D rendering engine
https://github.com/KTStephano/StratusGFX

3d 3d-graphics computer-graphics computer-graphics-opengl game-dev game-development gamedev global-illumination graphics graphics-3d graphics-engine graphics-programming graphics-rendering linux opengl pbr rendering rendering-3d-graphics rendering-engine windows

Last synced: about 1 month ago
JSON representation

Realtime 3D rendering engine

Awesome Lists containing this project

README 

        
# ![logo](https://user-images.githubusercontent.com/8399235/254135954-84b9cb9a-b01e-43e0-8a3c-16217af4432e.jpg)



Release State: **Pre-Release/Beta**



Engine Version: **0.10**



Realtime 3D rendering engine. Expect bugs and instability as it is still under development. The engine is free and open source (licensed under MPL-2.0). Please feel free to contact me about any questions or issues you have!



![sponza1](https://ktstephano.github.io/assets/v0.10/SponzaGI_Front.png)



![sponza2](https://ktstephano.github.io/assets/v0.10/SponzaGI.png)



(3D Model: Intel Sponza)



![bistro1](https://ktstephano.github.io/assets/v0.10/Bistro1.png)



![bistro2](https://github.com/KTStephano/ktstephano.github.io/blob/main/assets/v0.10/Bistro2.png)



(3D Model: Bistro)



![sanmiguel1](https://ktstephano.github.io/assets/v0.10/FinalAfterPostProcessing.png)



![sanmiguel2](https://ktstephano.github.io/assets/v0.10/SanMiguel_Balcony2.png)



![sanmiguel3](https://github.com/KTStephano/ktstephano.github.io/blob/main/assets/v0.10/SanMiguel_GI2.0.png)



(3D Model: San Miguel)



![cornell_front](https://ktstephano.github.io/assets/v0.10/Cornell_Front.png)



![cornell_back](https://ktstephano.github.io/assets/v0.10/Cornell_Back.png)



(3D Model: Cornell Box)



-> [Video Feature Reel](https://www.youtube.com/watch?v=dj0wVxwd1ng)



-> [Graphics Image Feature Reel](https://ktstephano.github.io/rendering/stratusgfx/feature_reel)



-> [High Level Architecture Overview](https://ktstephano.github.io/rendering/stratusgfx/architecture)



-> [How A Frame Is Rendered](https://ktstephano.github.io/rendering/stratusgfx/frame_analysis_v0_10)



# Roadmap for Engine Version 0.11 (in development)



* [Virtual shadow maps](https://ktstephano.github.io/rendering/stratusgfx/svsm)

* New Vulkan + DirectX 12 graphics backend (dropping OpenGL support)

* Two-pass occlusion culling

* Texture streaming

* Improved GI quality and performance

* New engine module system for easier extensibility

* Refactored renderer to make adding custom passes easier



# Purpose



This project was created as a hobby research project for learning low level engine development and implementing modern graphics techniques.



# Use Cases



At its core Stratus is a rendering engine first with minimal features found in general purpose engines. Its focus is on modern 3D graphics capabilities. Because of this it has two main use cases:



1) People taking it and using it as a learning resource.



2) Integration into other general purpose engines (new or existing) and modeling tools.



Because of the MPL license, any community changes made to the rendering code will continue to help others in new and existing projects that use it.



# Current Supported Features



### Graphics



* Physically based metallic-roughness pipeline

* Realtime global illumination

* Spatiotemporal image denoising

* Raymarched volumetric lighting and shadowing

* Cascaded shadow mapping

* Deferred lighting

* Mesh LOD generation and selection

* GPU Frustum Culling

* Screen Space Ambient Occlusion (SSAO)

* Reinhard or ACES Tonemapping

* Fog

* Bloom

* Fast Approximate Anti-Aliasing (FXAA)

* Temporal Anti-Aliasing (TAA)



### Engine



* Pool allocators

* GPU memory allocators/managers

* Multi threaded utilities

* Concurrent hash map

* Entity-Component System (ECS)

* Logging



### Modern graphics API features used



* Compute shaders

* Direct state access

* Programmable vertex pulling

* Multi draw elements indirect

* Shader storage buffer



# Software/Driver Requirements



| Type | Requirement |

| --- | --- |

| OS | Windows 10/11 or Linux |

| Compiler | Support for C++17 |

| Graphics | Support for OpenGL 4.6 |



# Minimum Hardware Requirements



| Type | Minimum |

| --- | --- |

| CPU | Ryzen 3 1200 (quad core) |

| RAM | 8 GB |

| GPU | Nvidia GTX 1050 Ti |



# Downloading Sample 3D Model Data



1) A zip file containing Sponza, Interrogation Room, San Miguel, Bistro, Bathroom, etc. can be found here: [https://drive.google.com/file/d/1nVkEuhDaSK61XmTSoNOUUEU5a-U-mtKO/view?usp=share_link](https://drive.google.com/file/d/1nVkEuhDaSK61XmTSoNOUUEU5a-U-mtKO/view?usp=share_link)



2) Extract the Resources.zip folder into the root of StratusGFX. It will then be at the same level as Bin/, Examples/, Source/, Tests/. Make sure that the folder structure looks like StratusGFX/Resources/* where * will be folders such as Sponza, Bistro, etc.



(see further down this README for a full list of credits for where the sample 3D model data came from)



# Building For Windows & Linux



This code base will currently not work on MacOS. Linux and Windows should both be fine so long as the graphics driver supports OpenGL 4.6 and the compiler supports C++17.



First set up the repo



    git clone --recursive https://github.com/KTStephano/StratusGFX.git

    cd StratusGFX



## Prerequisites



Make sure your graphics drivers are up-to-date.



On Linux you will likely need to install the following packages:



    libgl1-mesa-dev

    libxext-dev



(or the equivalent for your distro)



## Option 1: Standard Build



This is the preferred build if all you want to do is build the examples and run them.



    python3 ./build_examples.py --assimp



-> LINUX NOTE: If you get an error during the assimp build of the above step, use your local package manager to install assimp instead. Then re-run the above step as:



    python3 ./build_examples.py



Now you should be able to go into the StratusGFX/Bin/ folder and run the examples!



## Option 2: Development Build



Use this if you plan to make source code changes to anything in Examples/ Source/ or Tests/. You will only need to build the dependencies once and then after that you can just re-run the cmake build step any time you make changes.



Build 3rd party dependencies -> should only need to do this once per clone



    python3 ./dependency_build.py --assimp



-> LINUX NOTE: If you get an error while building assimp, use your local package manager to install assimp instead. Then re-run the above step as:



    python3 ./dependency_build.py



Now build the StratusGFX source



### Windows



    cmake -Bbuild -S. -DBUILD_TESTS=ON

    cmake --build build/ -j 8 --config RelWithDebInfo



### Linux



    cmake -Bbuild -S. -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTS=ON

    cmake --build build/ -j 8



All executables will be put into StratusGFX/Bin folder. Make sure you run them while inside StratusGFX/Bin/. Good ones to run to see if it worked are 



    Ex00_StartupShutdown.exe (runs through initialize, run one frame, shutdown sequence)

    Ex01_StratusGFX.exe (you should see a forest of red cubes since textures aren't bundled with source)

    StratusEngineUnitTests.exe

    StratusEngineIntegrationTests.exe



# Running The Examples



If you are having trouble with the downloading of the 3D assets or running the examples, a good place to check is here:



[https://github.com/KTStephano/StratusGFX/wiki/Examples](https://github.com/KTStephano/StratusGFX/wiki/Examples)



If this does not help then feel free to send me an email ([email protected]) or open an issue.



# Credits For 3D Assets Used In Examples



Credits for the 3D assets used in the examples/demos are as follows:



[Crytek Sponza](https://github.com/KhronosGroup/glTF-Sample-Models/tree/main/2.0/Sponza)



[Intel Sponza](https://www.intel.com/content/www/us/en/developer/topic-technology/graphics-research/samples.html)



[San Miguel](https://casual-effects.com/data/)



[Bistro](https://developer.nvidia.com/orca/amazon-lumberyard-bistro)



[Junk Shop](https://cloud.blender.org/p/gallery/5dd6d7044441651fa3decb56)



[The Bathroom](https://sketchfab.com/3d-models/the-bathroom-free-d5e5035dda434b8d9beaa7271f1c85fc)



[Interrogation Room](https://sketchfab.com/3d-models/interogation-room-6e9151ec29494469a74081ddc054d569)



[Abandoned Warehouse](https://sketchfab.com/3d-models/abandoned-warehouse-1e40d433ed6f48fb880a0d2172aff7ca)



# First Places to Look



You can check [High Level Architecture Overview](https://ktstephano.github.io/rendering/stratusgfx/architecture), or you can start by looking through the code under Examples/ExampleEnv00 and Examples/ExampleEnv01. They both depend on code that is inside of Examples/Common which is another good place to look around.



None of the test scenes are bundled with this source so the rest of the environments will be completely blank when running.



# Controls For Example Environments



WASD to move



Left mouse to fly up, right mouse to fly down



U unlocks look up/look down for camera



F toggles camera light



E toggles directional light



G toggles global illumination



R recompiles all shaders