Home / Wiki / Overview
Documentation layer
Raiju Renderer Wiki
A human-readable guide for the Raiju Renderer codebase. Start here to understand
the renderer workflow, then jump into the exact classes, files, and generated API
pages when you need implementation detail.
Vulkan 1.3 Explicit rendering API
C++20 Renderer implementation
Dynamic Rendering Main colour/depth pass
Milestone 2 Textured OBJ vertical slice
How to use this wiki
Start broad, then drill into the API
Read the project path
Use Getting started
to install dependencies, configure CMake, build the renderer, and run
the executable from the correct output directory.
Understand the module boundaries
Use Architecture
to see which system owns Vulkan setup, swapchain images, command
submission, pipelines, mesh buffers, textures, and the debug UI.
Follow one frame
Use Rendering loop
to trace acquire, command recording, Dynamic Rendering, image barriers,
submit, present, and resize recovery.
Open the API reference
Use API map
when you know the subsystem and want the exact class, file, member list,
or source-browser page in the generated API reference.
Wiki pages
Documentation index
Getting started
Requirements, build presets, run paths, validation layers, and first checks.
Architecture
Responsibility breakdown for the renderer's main systems and ownership boundaries.
Rendering loop
The complete frame lifecycle from fence wait to presentation and swapchain rebuild.
Assets and shaders
OBJ import, texture loading, shader compilation, descriptor binding, and debug views.
API map
Curated links into generated classes, structs, namespaces, source files, and globals.
Troubleshooting
Common build, runtime, Vulkan loader, asset path, shader, and resize issues.
Project summary
What Raiju Renderer currently does
Renderer scope
A compact C++20 Vulkan 1.3 renderer focused on explicit GPU setup,
Dynamic Rendering, swapchain management, resource upload, command recording,
synchronisation, and presentation.
Current milestone
Milestone 2 vertical slice: textured OBJ rendering, depth testing, ImGui
debug controls, wireframe pipeline variant, normals view, culling toggle,
and resize-safe swapchain recreation.
Core API choice
Uses Vulkan 1.3 Dynamic Rendering instead of legacy VkRenderPass
and VkFramebuffer objects for the main colour/depth pass.
Generated docs
The API reference is generated from README.md, src/,
and docs/dev-log/, so exact types and functions sit beside this wiki.
Raiju Renderer wiki. Use these pages together with the codebase and API map
when you need exact engine details.