NOTE: I moved development of this repo to my graphics engine that also supports Vulkan (see here).

Key Features • How To Use • Download • Related • License • Literature

This project provides me a solid modern OpenGL renderer starting point for implementing modern established rendering techniques and getting quickly started in own research topics.
Frequently tested under

• [latest windows and ubuntu version]
• [GCC/CLANG/MSVC]

With the provided CMake file you are able to built the project on Linux (Ubuntu is tested) and Windows. I do not provide support for MacOS. Be aware of the dependencies:

• OpenGL 4.6
• GLAD
• glm
• glfw
• tinyobjloader
• imgui
• glad
• stb
• doxygen
• gtest
• cmake
• gsl
• NSIS

• cppcheck
• renderdoc
• nsightgraphics
• valgrind
• clangtidy
• visualstudio
• ClangPowerTools
• Codecov

You might only clone the repo and get to go immediately :)

Dependencies to libraries are stated above.
C 20 or higher required.
C17 or higher required.
CMake 3.20 or higher required.

NOTE: This project relies on the newest OpenGL version and their features.

1. Clone the repo

   $ git clone --recurse-submodules [email protected]:Kataglyphis/GraphicEngine.git

   Important for init the submodules.

   NOTE: With powershell in Windows git has currently a problem with cloning recursively. You might consider using the git bash.

2. Then build your solution with [CMAKE] (https://cmake.org/)
   Here the recommended way over command line after cloning the repo:
   (for clarity: Assumption you are in the dir you have cloned the repo into)

$ mkdir build ; cd build
# enlisting all available presets
$ cmake --list-presets=all ../
$ cmake --preset <configurePreset-name> ../
$ cmake --build --preset <buildPreset-name> .
# necessary for making Resources available to test framework
$ cmake -E copy_directory ../Resources/ Test/Resources/

Alternatively you can use the build scripts I use for my standard configuration:

• [buildEngine.sh]
• [buildEngine.bat]

$ {WORKING_DIR}/GraphicsEngine/buildEngine[.sh/.bat]

• Watch test results here

Watch the refman generated by doxygen.

• Watch it here

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the GPL-3.0 License. See LICENSE for more information.

Jonas Heinle - @Cataglyphis_ - [email protected]

Project Link: https://github.com/Kataglyphis/GraphicsEngine

I want to thank my partner Kansei who worked with me on a project. This project arised from this university project.

• Loading Screen Image

Thanks for free 3D Models:

• Morgan McGuire, Computer Graphics Archive, July 2017 (https://casual-effects.com/data)

Some very helpful literature, tutorials, etc.

• View Frustum Culling

CMake/C

• Cpp best practices

OpenGL

• learnopengl.com
• ogldev.org
• Cascaded Shadow Maps
• Compute Shader in OpenGL

Clouds

• pbr-book
• Inigo Quilez
• Shadertoy Horizon Zero Dawn
• Sebastian Lague
• Horizon Zero Dawn
• Clouds and noise
• Shadertoy Clouds using 3D Perlin noise

Noise

• Worley noise online demo

Physically Based Shading

• Advanced Global Illumination by Dutre, Bala, Bekaert
• The Bible: PBR book
• Real shading in Unreal engine 4
• Physically Based Shading at Disney
• RealTimeRendering
• Understanding the Masking-Shadowing Function in Microfacet-Based BRDFs
• Sampling the GGX Distribution of Visible Normals