Skip to content

Commit d908feb

Browse files
authored
Create README.md
1 parent 39cd060 commit d908feb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Reactor
2+
3+
A modern C++ Vulkan renderer built using Vulkan-Hpp, designed with extensibility and clarity in mind. This renderer leverages dynamic rendering, multi-sample anti-aliasing (MSAA), HDR rendering, and a modular render loop architecture to simplify development of real-time graphics applications.
4+
5+
## ✨ Features
6+
- Vulkan-Hpp: Modern C++ bindings for Vulkan for type safety and cleaner API.
7+
- Dynamic Rendering: No need for complex render pass setups.
8+
- MSAA + Resolve: High-quality anti-aliasing using MSAA images resolved into HDR buffers.
9+
- HDR Rendering: Full 16-bit float rendering pipeline using R16G16B16A16_SFLOAT.
10+
- ImGui Integration: Built-in user interface rendering support.
11+
- Robust Frame Management: Supports multiple frames in flight.
12+
- Descriptor Management: Automatic uniform buffer updates and descriptor set handling.
13+
- Swapchain Resilience: Handles window resize events and swapchain recreation cleanly.
14+
15+
## 🚀 Getting Started
16+
17+
**Prerequisites**
18+
- Vulkan SDK (1.3+)
19+
- C++20 compiler (e.g., clang++ or g++)
20+
- CMake (3.18+)
21+
- glfw for windowing
22+
- glm for math
23+
- Vulkan Memory Allocator (VMA) for efficient GPU memory management
24+
- ImGui for UI
25+
26+
### 📜 License
27+
28+
MIT License. See LICENSE for details.

0 commit comments

Comments
 (0)