# thenumbat/diopter architecture

> Architecture diagram of the GitHub repository thenumbat/diopter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thenumbat/diopter
- Repository: https://github.com/thenumbat/diopter

## Overview

##### Main Components

a) Core Engine Components:
- Renderer System (src/renderer/)
- Scene Management (src/scene/)
- GUI System (src/gui/)
- Platform Layer (src/platform/)
- Shader Pipeline (src/shaders/)

b) External Dependencies:
- Vulkan (via rvk)
- SDL2 (for window management and input)
- Various asset loading libraries (rply, tinyexr, tinygltf)

**┌─ Application Layer ─────────────────────┐**
- GUI System │ Scene Management │ Camera  │
- ┤
- Renderer System              │
- ┤
- Shader Pipeline              │
- ┤
- Platform Layer (SDL2, Window Management)│
- ┘

##### Component Details

For each major component, highlight:

a) Renderer System:
- Geometry Processing
- Material Path Tracing
- Ambient Occlusion
- Post-Processing
- Shading Pipeline

b) Scene Management:
- GLTF Loader
- PBRT Loader
- PLY Loader
- GPU Scene Representation

c) Shader Pipeline:
- Material Shaders
- Geometry Shaders
- Ray Tracing Shaders
- Post-Processing Shaders

##### Data Flow Indicators

- Asset loading flow (GLTF/PBRT → Scene Management → GPU Scene)
- Render pipeline flow (Scene → Geometry → Material Path → Post-Processing)
- User input flow (Platform Layer → GUI → Renderer)

##### Technical Details

- Vulkan 1.3 requirements
- Hardware ray tracing dependency
- Supported material types
- Asset format support (PBRT, GLTF)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Application
        GUI["GUI System"]:::gui
        Scene["Scene Management"]:::scene
        Camera["Camera System"]:::app
    end

    subgraph Renderer
        GeomProc["Geometry Processing"]:::renderer
        MatPath["Material Path Tracing"]:::renderer
        AO["Ambient Occlusion"]:::renderer
        PostProc["Post-Processing"]:::renderer
        Shading["Shading System"]:::renderer
    end

    subgraph ShaderPipeline
        MatShaders["Material Shaders"]:::shader
        GeomShaders["Geometry Shaders"]:::shader
        RTShaders["Ray Tracing Shaders"]:::shader
        PostShaders["Post-Processing Shaders"]:::shader
    end

    subgraph Platform
        Window["Window Management"]:::platform
        SDL["SDL2 Implementation"]:::platform
    end

    subgraph SceneLoaders
        GLTF["GLTF Loader"]:::loader
        PBRT["PBRT Loader"]:::loader
        PLY["PLY Loader"]:::loader
        GPUScene["GPU Scene"]:::loader
    end

    %% Core Application Components
    Core["Core Engine"]:::core
    Main["Main Entry"]:::core

    %% Relationships
    Main --> Core
    Core --> GUI
    Core --> Scene
    Core --> Camera

    Scene --> SceneLoaders
    GLTF & PBRT & PLY --> GPUScene
    GPUScene --> GeomProc

    GUI --> Window
    Window --> SDL

    GeomProc --> MatPath
    MatPath --> AO
    AO --> PostProc
    PostProc --> Shading

    GeomProc --> GeomShaders
    MatPath --> MatShaders
    AO & MatPath --> RTShaders
    PostProc --> PostShaders

    %% Click Events
    click GUI "https://github.com/TheNumbat/Diopter/tree/main/src/gui/"
    click Scene "https://github.com/TheNumbat/Diopter/tree/main/src/scene/"
    click Camera "https://github.com/TheNumbat/Diopter/blob/main/src/util/camera.cpp"
    click GeomProc "https://github.com/TheNumbat/Diopter/blob/main/src/renderer/geometry.cpp"
    click MatPath "https://github.com/TheNumbat/Diopter/blob/main/src/renderer/matpath.cpp"
    click AO "https://github.com/TheNumbat/Diopter/blob/main/src/renderer/ao.cpp"
    click PostProc "https://github.com/TheNumbat/Diopter/blob/main/src/renderer/post.cpp"
    click Shading "https://github.com/TheNumbat/Diopter/blob/main/src/renderer/shading.cpp"
    click MatShaders "https://github.com/TheNumbat/Diopter/tree/main/src/shaders/materials/"
    click GeomShaders "https://github.com/TheNumbat/Diopter/tree/main/src/shaders/geometry/"
    click RTShaders "https://github.com/TheNumbat/Diopter/tree/main/src/shaders/matpath/"
    click PostShaders "https://github.com/TheNumbat/Diopter/tree/main/src/shaders/post/"
    click Window "https://github.com/TheNumbat/Diopter/blob/main/src/platform/window.cpp"
    click SDL "https://github.com/TheNumbat/Diopter/blob/main/src/platform/imgui_impl_sdl2.cpp"
    click GLTF "https://github.com/TheNumbat/Diopter/blob/main/src/scene/gltf.cpp"
    click PBRT "https://github.com/TheNumbat/Diopter/blob/main/src/scene/pbrt.cpp"
    click PLY "https://github.com/TheNumbat/Diopter/blob/main/src/scene/rply.cpp"
    click GPUScene "https://github.com/TheNumbat/Diopter/blob/main/src/scene/gpu_scene.cpp"
    click Core "https://github.com/TheNumbat/Diopter/blob/main/src/diopter.cpp"
    click Main "https://github.com/TheNumbat/Diopter/blob/main/src/main.cpp"

    %% Styles
    classDef core fill:#f9f,stroke:#333,stroke-width:2px
    classDef gui fill:#aaf,stroke:#333,stroke-width:2px
    classDef scene fill:#afa,stroke:#333,stroke-width:2px
    classDef app fill:#ffa,stroke:#333,stroke-width:2px
    classDef renderer fill:#99f,stroke:#333,stroke-width:2px
    classDef shader fill:#f9f,stroke:#333,stroke-width:2px
    classDef platform fill:#ff9,stroke:#333,stroke-width:2px
    classDef loader fill:#9f9,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["GUI Components"]:::gui
        L3["Scene Components"]:::scene
        L4["Application Components"]:::app
        L5["Renderer Components"]:::renderer
        L6["Shader Components"]:::shader
        L7["Platform Components"]:::platform
        L8["Loader Components"]:::loader
    end
```
