mrtroble/graphicsenginevulkan

Serves as starting point for my rendering research/projects in vulkan.

Cataglyphis Renderer

A graphics engine built on top of Vulkan .

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

Table of Contents

1. About The Project
   • Built With
   • Key Features
2. Getting Started
   • Prerequisites
   • Installation
   • Shaders
3. Tests
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

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

Key Features

Feature	Implement Status
Rasterizer	✔️
Raytracing	✔️
Path tracing	✔️
PBR support (UE4,disney,... etc.)	✔️
.obj Model loading	✔️
Mip Mapping	✔️

Built With

• Vulkan 1.3
• glm
• glfw
• tinyobjloader
• stb
• vma
• tinygltf
• doxygen
• gtest
• cmake
• gsl
• NSIS

Useful tools (you might also considering :) )

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

Getting Started

Prerequisites

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

NOTE: This project relies on the new hardware capabilities for RRT.

Installation

1. Clone the repo

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

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/)

Tests

• Watch test results here

Code coverage results

Roadmap

Watch the refman generated by doxygen.

• Watch it here

Contributing

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

License

Distributed under the BSD 3-Clause "New" or "Revised" License. See LICENSE for more information.

Contact

Jonas Heinle - @Cataglyphis_ - [email protected]

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

Acknowledgements

You will find important links to information in the code. But here in general some good sources of information:

Thanks for free 3D Models:

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

Literature

Some very helpful literature, tutorials, etc.

CMake/C++

• Cpp best practices

Vulkan

• Udemy course by Ben Cook
• Vulkan Tutorial
• Vulkan Raytracing Tutorial
• Vulkan Tutorial; especially chapter about integrating imgui
• NVidia Raytracing tutorial with Vulkan
• Blog from Sascha Willems

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

Path tracing

• NVIDIA Path tracing Tutorial