Inexor vulkan-renderer

A new and modern 3D game engine for Linux and Windows using C++20 and Vulkan API 1.3 in early development.

Documentation

• Getting Started
  • Required Hardware
  • Supported Platforms
  • Required Software for Development
  • Optional Software
  • CMake Build Targets
  • CMake Build Options
  • Building on Windows
  • Building on Linux
• Engine Overview
  • General
    • Engine Parallelization Strategy
    • Rendergraph: A Generic Abstraction for Rendering
  • Development
    • CMake Build System
    • Continuous Integration (CI)
    • Static Code Analysis (SCA)
    • Automatic Code Formatting
    • Engine Benchmarking
    • Engine Unit Tests
  • Debugging
    • RenderDoc Graphics Debugger
    • Console Logging and Logfiles
    • Vulkan Validation Layers
    • Command Line Arguments
    • VMA dumps
    • Regressions
  • C++ Code Design and Style
    • Why use C++?
    • Used Features of Modern C++
    • Dependencies
    • C++ Code Design
    • C++ Core Guidelines
    • C++ Design Patterns
    • RAII in C++: Ensuring Safe Vulkan Resource Management
    • Parameter Ordering Guidelines
    • Variable Abbreviation Guidelines
    • Memory Allocators in C++
    • Dependency Injection
    • Folder Structure
  • Modern C++ for Vulkan API
    • Command Pools and Command Bufers
    • Error Handling with Exceptions
    • Dynamic Rendering
    • Resource Descriptor Management
    • Graphics Pipeline Management
    • Swapchain Management
    • Vulkan Synchronization: Fences and Semaphores
    • Vulkan Synchronization: Pipeline Barriers and Events
    • Vulkan Synchronization: Timeline Semaphores
    • Shader Management
    • Texture Management and Compressed Image Formats
    • Shader Reflection with SPIRV-Cross
    • Vulkan Memory Allocator (VMA)
    • Loading Vulkan with volk meta-loader
  • Octree
    • Octree Introduction
    • Octree Collision Detection
    • Octree File Format
    • Octree Material System
    • Octree Template System
  • glTF2 Models
    • Loading glTF2 Models
    • Rendering glTF2 Models
  • Entity Component System (ECS)
    • EnTT Integration
  • Miscellaneous
    • Automatic GPU Selection
    • Camera Class
    • Keyboard and Mouse Input
    • GitHub Issue Labeling
    • Engine Metadata
    • Assets
    • Time Step
    • ImGui Integration
    • TOML configuration files
• Frequently Asked Questions
  • What is Inexor?
  • How to build?
  • Which platforms are supported?
  • What is the current state of the project?
  • How is Inexor organized?
  • How to contact us?
  • What is Vulkan API?
  • Why is Vulkan API the future?
  • Can you explain Vulkan API in simple terms?
  • How difficult is development with Vulkan API?
  • Does my graphics card support Vulkan API?
  • Will you support other rendering APIs?
  • Is Vulkan API restricted to any operating system?
  • Which graphics cards do you use for testing the engine?
• C++ Code Documentation
  • Page Hierarchy
  • File Hierarchy
  • Full API
    • Namespaces
    • Classes and Structs
    • Enums
    • Unions
    • Functions
    • Variables
    • Typedefs
• Helpful Links
  • Advantages of Vulkan API
  • Getting Started with Vulkan API
  • Beginner Vulkan API Tutorials
  • Advanced Vulkan API Tutorials
  • Migrating to Vulkan API
  • Vulkan Validation Layers
  • Graphics Debuggers
  • Modern C++
• How to Contribute
  • Contribute Code
    • Signing Commits
    • Commit Naming Convention
  • Contribute Art
  • List of Contributors
  • License Guidelines
    • Accepted Licenses
    • Unaccepted Licenses
    • Special Notes
    • Common Mistakes
• Changelog
• MIT License
• Contact