GLX - Graphics Engine

GLX is an early-stage cross-platform OpenGL graphics engine for learning purposes, inspired by the lessons from the online book LearnOpenGL.

Getting Started

1. Downloading the repository:

Start by cloning the repository with:

git clone --recurse-submodules [email protected]:Trippasch/GLX.git

You can also use --remote-submodules to clone the submodules to their latest revision. If the repository was cloned non-recursively previously, use git submodule update --init to clone the necessary submodules.

2. Generate Project files:

You can use CMake to generate the project files and build the project.

To streamline the building process you can also use the invoke python library. You can install it with pip install invoke.

• inv config to generate the project files.
• inv build to build the project.
• inv run to run the project.

To use Debug mode do:

• inv config --build-type=Debug to generate the project files.
• inv build --build-type=Debug to build the project.
• inv run --build-type=Debug to run the project.

** You can change the configuration of cmake in tasks.py.

3. Clean Project files:

• inv clean to clean the project files.

Dependencies

The project uses the following dependencies:

• Assimp for 3d model importing.
• ImGui for creating graphical user interfaces (GUIs).
• GLM for vector math.
• GLFW for creating windows, contexts and surfaces.
• Glad for generating OpenGL functions.
• spdlog for logging.
• stb for image loading.
• CMake for building the project.