72 lines
3.9 KiB
C
72 lines
3.9 KiB
C
// =====================================================================================================================
|
|
// fennec, a free and open source game engine
|
|
// Copyright © 2025 Medusa Slockbower
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
// =====================================================================================================================
|
|
|
|
///
|
|
/// \file engine.h
|
|
/// \brief fennec::engine definition
|
|
///
|
|
///
|
|
/// \details
|
|
/// \author Medusa Slockbower
|
|
///
|
|
/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
|
|
///
|
|
///
|
|
|
|
///
|
|
/// \page contents Contents
|
|
///
|
|
/// 1. \ref introduction "Introduction"
|
|
/// 1. \ref coding-standards "Coding Standards"
|
|
/// 2. \ref building-from-source "Building from Source"
|
|
/// 1. \ref building-from-terminal "Building from Terminal"
|
|
/// 1. \ref debian "Debian"
|
|
/// 2. \ref fedora-dnf "Fedora"
|
|
/// 2. \ref building-on-windows "Building on Windows"
|
|
/// 3. \ref running-the-test-suite "Running the Test Suite"
|
|
/// 4. \ref usage "Usage"
|
|
/// 1. \ref licensing "Licensing"
|
|
/// 5. \ref contribution "Contribution"
|
|
/// 6. \subpage libraries
|
|
/// 1. \ref fennec_lang "C++ Language Library"
|
|
/// 2. \ref fennec_math "Math Library"
|
|
/// 2. \ref fennec_memory "Memory Management Library"
|
|
/// 2. \ref fennec_containers "Containers Library"
|
|
///
|
|
/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
|
|
///
|
|
|
|
///
|
|
/// \page libraries Libraries
|
|
///
|
|
/// | Library | Brief |
|
|
/// |:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
/// | \subpage fennec_lang | Implementation for functions and classes related to the C++ Language, including base types, common utility functions, and metaprogramming templates |
|
|
/// | \subpage fennec_math | Implementation of math functions according to the [OpenGL 4.6 Shading Language Specification](https://registry.khronos.org/OpenGL/specs/gl/GLSLangSpec.4.60.pdf). Additional extensions are provided for other common math functions. |
|
|
/// | \subpage fennec_memory | Implementation of functions related to memory management. |
|
|
/// | \subpage fennec_containers | Implementation of common data structures, those that are specified in the C++ STD Library, and custom data structures that fennec uses. |
|
|
///
|
|
///
|
|
/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
|
|
///
|
|
|
|
#ifndef FENNEC_CORE_ENGINE_H
|
|
#define FENNEC_CORE_ENGINE_H
|
|
|
|
#endif // FENNEC_CORE_ENGINE_H
|