Introduction

Welcome to the Wisdom project documentation. This library provides minimal abstraction for a low level graphics. It is designed to be lightweight and efficient, focusing on modern C++ standards and best practices with a lot of optimizations for best performance. Wisdom is built with a strong emphasis on extensibility and maintainability, making it suitable for a wide range of applications.

Note: DOCUMENTATION IS IN PROGRESS. Would appreciate any feedback or contributions to improve it.

Coding Standards and Documentation

Wisdom follows no particular coding standard, when it comes to implementation part. All the public API is generated with custom generator and follows a consistent style. The code is documented using Doxygen, and we strive to keep the documentation up-to-date with the codebase.

Note: Please refer to the Contributing page for guidelines on contributing to the project.

Documentation from 25.8.2025 will adhere to the RFC 2119 guidelines for requirement levels. Latest statement can be found here: https://www.rfc-editor.org/rfc/rfc2119.html

Quick Navigation

Getting Started - Learn how to build the library and integrate it into your project
Consumption - Installation and configuration instructions
Library Structure - Overview of the library structure and components
Initialization - Basic examples of how to use the Wisdom library
Contributing - Contribution guidelines and how to get involved

Key Features

Modern C++ support (C++20/C++23)
CMake integration
Cross-platform compatibility
Open-end extensibility
High performance with minimal overhead

Requirements

CMake 3.22 or higher
C++20 compatible compiler
Vulkan SDK <optional for Windows>

Contact & Support

For questions, issues, or contributions, please refer to the project repository at https://github.com/Agrael1/Wisdom