Skip to content

Latest commit

 

History

History
233 lines (171 loc) · 9.73 KB

README.md

File metadata and controls

233 lines (171 loc) · 9.73 KB
Raw

Tefnout Engine

A Game Engine project with a focus on learning more about architecture and advanced concept of C++ like implementing STL compliant classes (see Tefnout::Buffer::Ring as an example).

Continuation of previous work at SimpelGL but the architecture is rewritten from scratch.

Currently only OpenGL is supported on both Windows and GNU/Linux but Vulkan is planned.

What I am currently working on:

  • OpenGL 2D rendering pipeline (VertexArray, FrameBuffer, Renderer, Texture, Shader)
  • Abstract 2D renderer (because I want OpenGL and Vulkan support)
  • GUI with ImGui
  • ECS based on Sparse set

What is planned:

  • Vulkan support
  • Continuous integration testing with Circle CI

Getting started (Dev)

Setup dependencies

Engine:

Tests only:

After getting the repository all sub-modules must be fetched. Then you can follow each specific dependency configuration as described below:

git submodule update --init --recursive

glm

LICENSE - MIT

Nothing to do.

Spdlog

LICENSE - MIT

In order to reduce compilation time, pre-compiled header for the spdlog dependency must be built first as below for both DEBUG and RELEASE targets. System library could also be used if already installed.

# Move to spdlog sub-module
cd Tefnout/vendors/spdlog/
# Create the build directory
mkdir build && cd build

# Debug version
cmake .. -G "Ninja" -D CMAKE_BUILD_TYPE=Debug -D SPDLOG_BUILD_SHARED=OFF -D SPDLOG_FMT_EXTERNAL=ON -D SPDLOG_BUILD_EXAMPLE=OFF -D SPDLOG_BUILD_TESTS=OFF -D CMAKE_INSTALL_PREFIX=./build/install/Debug -D CMAKE_POSITION_INDEPENDENT_CODE=ON
# Compile and install to build/install/Debug
ninja install

# Release version
cmake .. -G "Ninja" -D CMAKE_BUILD_TYPE=Release -D SPDLOG_BUILD_SHARED=OFF -D SPDLOG_FMT_EXTERNAL=ON -D SPDLOG_BUILD_EXAMPLE=OFF -D SPDLOG_BUILD_TESTS=OFF -D CMAKE_INSTALL_PREFIX=./build/install/Release -D CMAKE_POSITION_INDEPENDENT_CODE=ON
# Compile and install to build/install/Release
ninja install

OPENGL

LICENSE - Apache Version 2.0

As OpenGL is only a standard we still need to create the function pointers to each function at the driver level. However All cards do not support the same ammount of features from the standard. Then available functions must be implemented by the manufactor. Of course retrieving them is OS specific and its where GLAD shines.

GLAD

LICENSE - MIT

configuration used in this project is defined here and as been generated using the following parameters

  • Specification - OpenGL
  • Language - C/C++
  • gl API - 4.6
  • Profile - Core
  • Extensions - None

This dependency is already inside the project, so you have nothing to do expect be sure that OpenGL is installed on your computer. The $4.6$ version is not strictly required and not forced by cmake script.

# Get current installed OpenGL core profil version on Linux
glxinfo | grep "OpenGL core profile version"
# On my computer --> OpenGL core profile version string: 4.6 (Core Profile) Mesa 20.3.3

If you have OpenGL you can now move on to GLFW.

GLFW3

LICENSE - zlib

To be able to build Tefnout without using pre-compiled library use the following -D TEFNOUT_USE_PRECOMPILED_GLFW=OFF. To use pre-compiled libraries continue reading.

GLFW library could also be built first for both DEBUG and RELEASE targets using following commands. This step is optional but could improve compilation time.

# Move to glfw sub-module
cd Tefnout/vendors/glfw/

# Create the build directory
mkdir build && cd build

# Debug version (Dynamic)
cmake .. -G "Ninja" -D CMAKE_BUILD_TYPE=Debug -D GLFW_BUILD_DOCS=OFF -D GLFW_BUILD_TESTS=OFF -D GLFW_BUILD_EXAMPLES=OFF -D BUILD_SHARED_LIBS=ON -D CMAKE_INSTALL_PREFIX=./build/install/Debug
# Compile and install to build/install/Debug
ninja install

# Release version (Dynamic)
cmake .. -G "Ninja" -D CMAKE_BUILD_TYPE=Release -D GLFW_BUILD_DOCS=OFF -D GLFW_BUILD_TESTS=OFF -D GLFW_BUILD_EXAMPLES=OFF -D BUILD_SHARED_LIBS=ON -D CMAKE_INSTALL_PREFIX=./build/install/Release
# Compile and install to build/install/Release
ninja install

Stb_image

LICENSE - MIT or Public Domain

Nothing to do.

Catch2

LICENSE - Boost Software License 1.0

Nothing to do.

Build project

First all dependencies must be fetched and correctly initialized as described in Setup dependencies section.

Then follow the instructions below to generate the build files for any build tool using Cmake.

# 1) Be sure dependencies are correctly setup

# 2) Build project configuration for your editor of choice
cmake -G <build_tool> -B "./build" -S "."
# make
cmake -G "Unix Makefiles" -B "./build" -S "." -D CMAKE_EXPORT_COMPILE_COMMANDS=ON
# ninja
cmake -G "Ninja" -B "./build" -S "." -D CMAKE_EXPORT_COMPILE_COMMANDS=ON

In order to also build tests add the -D TEFNOUT_BUILD_TESTING=ON to the command above or update the Cmake cache in the build directory (CmakeCache.txt).

In order to also build lib as a shared library add the -D TEFNOUT_BUILD_SHARED_LIBS=ON to the command above.

Cmake can also be used to build targets:

cd build

# BUILD using 4 cores
cmake --build . -j 4

# CLEAN
cmake --build . --target clean

# REBUILD = CLEAN + BUILD
cmake --build . -j 4 --clean-first

A lot of warnings are enable by default to keep a healthy codebase but sometimes a static analyser can provide additional information. clang has a static analyser that can be used to generate a report:

# Scan the whole project and generate a HTML report if bugs are found
# --clean-first is used to make sure the target is built from scratch
scan-build --view --show-description -v --force-analyze-debug-code cmake --build build --clean-first

General information

Code structure

  • Header and source files should be in the same folder
  • Folder are split based on themes / purposes
  • Avoid #pragma once (not supported on every compilers) and does not allow headers aggregation
  • explicit constructor by default
  • Naming convention
    • only upper case for macro
    • camelCase for variables like variableName
    • pascalCase for type (structs, classes, ...) like TypeName
    • prefix with s_ static members like s_StaticAttribute
    • prefix with m_ private data to distinguish it from public data like m_height

clangd is used to run the clang formatter (see .clang-format)

Sublime-text / Vscode

I use the clangd LSP server for code completion and other features. The language server need a compile_commands.json file to provide IDE features.

The following step are needed in order to make IDE features works nicely

  • Use Cmake to generate the needed compile_commands.json
  • Add header information using compdb
  • Keep build and project compile_commands.json in sync

The one liner below performs all steps in a single command and must be run from the project root directory:

  1. Create build directory is needed
  2. Use local CmakeLists.txt as configuration for Cmake
  3. Generate makefiles for all targets
  4. Generate the compilation database
  5. Update database with header information
  6. Copy database to project folder to keep both in sync
# WITHOUT tests
cmake -G "Unix Makefiles" -B "./build" -S "." -D CMAKE_EXPORT_COMPILE_COMMANDS=ON && compdb -p ./build list > compile_commands.json && cp compile_commands.json ./build/compile_commands.json

# WITH tests
cmake -G "Unix Makefiles" -B "./build" -S "." -D CMAKE_EXPORT_COMPILE_COMMANDS=ON -D TEFNOUT_BUILD_TESTING=ON && compdb -p ./build list > compile_commands.json && cp compile_commands.json ./build/compile_commands.json

Tools

Some tools in Tools can be used to make developpement easier:

  • Purger.hs - Can be used to clean temporary files
    • cmake build data
    • clangd compile commands
    • tefnout logs
  • Init.hs - Can be used to automaticaly init the whole project by performing the following actions in sequence:
    • Init and pull submodules
    • Build spdlog in both Debug and Release
    • Build glfw in both Debug and Release
    • Build Tefnout in both Debug and Release
      • Tefnout as Shared or Static
      • Tests for all targets (4)
      • Samples for all targets (4)

Tools is a work in progress and are only tested on GNU/Linux.

Side note

Ninja appears to be more performant for incremental build than make where there is no difference in speed when compiling from scratch.

Other

cmake can build project configuration for every avaiblable tools. More information in the Getting Started section.