Epsilon Renderer

A tiny little vulkan/OpenGL renderer. The precursor to Epsilon

Setup

Prerequisites

• Windows or Linux (Mac untested)
• Cmake (3.19 minimum)
• Vulkan 1.2 API or OpenGL 4.6
• MSVC C++ 2019/GCC++/Clang

Git Submodules

Before compiling the project, you must set up essential libraries through git. To do that you must initialize the submodules inside this project. Enter the following commands through the git bash/terminal on the root project folder.

$ git submodule init
$ git submodule update --init

This will clone libraries necessary for this project and add them to the lib/ folder. Cmake will automatically compile and link the libraries to the renderer.

Libraries Installed:

• GLFW
• Assimp
• Imgui (docking branch)

Compilation

In order to compile the program, you will need to use CMake commands to do so,

$ cmake --target EpsilonRenderer --build <binary directory>

The program executable will be located at <binary directory>.

Documentation

Before generating the documentation for this project, you must install Doxygen 1.9.1 or later in a directory visible to CMake (the default directory should do).

To generate the documentation for this project change the CMake target to Epsilon_Documentation instead.

$ cmake --target Epsilon_Documentation --build <output directory>

The following command will create the doxygen-generated documentation at <output directory>/docs