# saltzus/vgframe architecture

> Architecture diagram of the GitHub repository saltzus/vgframe, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/saltzus/vgframe
- Repository: https://github.com/saltzus/vgframe

## Overview

VGFrame is a C++ real-time graphics framework with OpenGL and Vulkan backends. Its user-facing workflow centers on creating a window, preparing model/render data and shaders, and rendering through a selected graphics backend; the tree also exposes physics, input, GUI, text, audio, and resource facilities. The excerpts show the renderer abstraction, backend interfaces, model capabilities, and shader pipeline, but not enough call sites to establish most runtime dispatch paths. Dashed links indicate those unverified relationships.

Main entry points: [`VGF/src/VGF/Renderer.cpp`](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Renderer.cpp) (Renderer), [`VGF/src/VGF/Model.cpp`](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Model.cpp) (Models), [`VGF/src/VGF/graphicsApi/vulkan/VulkanManager.cpp`](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanManager.cpp) (Vulkan backend), [`VGF/src/VGF/Physics.cpp`](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Physics.cpp) (Physics)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Window and input"]
  node_window["Window<br/>[Window.cpp]"]
  node_input["Input<br/>[Input.cpp]"]
  node_gui["GUI<br/>[Gui.cpp]"]
end

subgraph group_scene["Scene and simulation"]
  node_model["Models<br/>[Model.cpp]"]
  node_physics["Physics<br/>[Physics.cpp]"]
  node_physicsobj["Physics objects<br/>[PhysicsObject.cpp]"]
  node_debugphysics["Physics debug"]
  node_camera["Camera<br/>[Camera.cpp]"]
  node_lights["Lights<br/>[DirectionalLight.h]"]
  node_audio["Audio<br/>[Audio.cpp]"]
end

subgraph group_assets["Assets and effects"]
  node_material["Materials<br/>[Material.cpp]"]
  node_texture["Textures<br/>[Texture.cpp]"]
  node_resource["Resources<br/>[Resource.cpp]"]
  node_text["Text and fonts<br/>[TextManager.cpp]"]
  node_shader["Shader config<br/>[Shader.cpp]"]
  node_compiler["Shader compiler<br/>[ShaderCompiler.cpp]"]
end

subgraph group_render["Rendering"]
  node_renderer["Renderer<br/>[Renderer.cpp]"]
  node_renderdata["Render data<br/>[RenderData.h]"]
  node_framebuffer["Frame buffers<br/>[FrameBuffer.cpp]"]
end

subgraph group_backends["Graphics backends"]
  node_opengl["OpenGL backend<br/>[OpenGLManager.cpp]"]
  node_opengui["OpenGL GUI<br/>[OpenglGui.cpp]"]
  node_vulkan["Vulkan backend<br/>[VulkanManager.cpp]"]
  node_pipeline["Vulkan pipeline"]
  node_vkframebuffer["Vulkan frame buffer"]
end

node_user(("Application"))

node_user -.->|"creates"| node_window
node_user -.->|"loads models"| node_model
node_user -.->|"uses simulation"| node_physics
node_window -.->|"initializes graphics"| node_renderer
node_input -->|"integrates input"| node_gui
node_input -->|"references physics"| node_physics
node_model -->|"uses materials"| node_material
node_material -->|"references textures"| node_texture
node_model -->|"references physics"| node_physics
node_physics -->|"references renderer"| node_debugphysics
node_model -->|"uses renderer"| node_renderer
node_model -->|"owns render data"| node_renderdata
node_renderer -->|"accepts shader"| node_shader
node_renderer -->|"uses camera"| node_camera
node_shader -->|"uses compiler"| node_compiler
node_shader -->|"uses resources"| node_resource
node_renderer -.->|"selects backend"| node_opengl
node_renderer -.->|"selects backend"| node_vulkan
node_opengl -.->|"GUI implementation"| node_opengui
node_vulkan -->|"creates pipelines"| node_pipeline
node_vulkan -->|"uses frame buffers"| node_vkframebuffer
node_gui -->|"backend implementation"| node_opengui
node_gui -->|"backend implementation"| node_vulkan
node_text -->|"references resources"| node_resource

click node_window "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Window.cpp"
click node_input "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Input.cpp"
click node_gui "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Gui.cpp"
click node_model "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Model.cpp"
click node_physics "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Physics.cpp"
click node_physicsobj "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/PhysicsObject.cpp"
click node_debugphysics "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/PhysicsDebugRenderer.cpp"
click node_camera "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Camera.cpp"
click node_lights "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/DirectionalLight.h"
click node_audio "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Audio.cpp"
click node_material "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Material.cpp"
click node_texture "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Texture.cpp"
click node_resource "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Resource.cpp"
click node_text "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/TextManager.cpp"
click node_shader "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Shader.cpp"
click node_compiler "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/ShaderCompiler.cpp"
click node_renderer "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Renderer.cpp"
click node_renderdata "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/RenderData.h"
click node_framebuffer "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/FrameBuffer.cpp"
click node_opengl "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/opengl/OpenGLManager.cpp"
click node_opengui "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/opengl/OpenglGui.cpp"
click node_vulkan "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanManager.cpp"
click node_pipeline "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanGraphicsPipeline.cpp"
click node_vkframebuffer "https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanFrameBuffer.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_window,node_input,node_gui toneBlue
class node_model,node_physics,node_physicsobj,node_debugphysics,node_camera,node_lights,node_audio toneAmber
class node_material,node_texture,node_resource,node_text,node_shader,node_compiler toneMint
class node_renderer,node_renderdata,node_framebuffer toneRose
class node_opengl,node_opengui,node_vulkan,node_pipeline,node_vkframebuffer,node_user toneIndigo
```

## Components

### Window and input

- [Window](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Window.cpp): `VGF/src/VGF/Window.cpp`
- [Input](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Input.cpp): `VGF/src/VGF/Input.cpp`
- [GUI](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Gui.cpp): `VGF/src/VGF/Gui.cpp`

### Scene and simulation

- [Models](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Model.cpp): `VGF/src/VGF/Model.cpp`
- [Physics](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Physics.cpp): `VGF/src/VGF/Physics.cpp`
- [Physics objects](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/PhysicsObject.cpp): `VGF/src/VGF/PhysicsObject.cpp`
- [Physics debug](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/PhysicsDebugRenderer.cpp): `VGF/src/VGF/PhysicsDebugRenderer.cpp`
- [Camera](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Camera.cpp): `VGF/src/VGF/Camera.cpp`
- [Lights](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/DirectionalLight.h): `VGF/src/VGF/DirectionalLight.h`
- [Audio](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Audio.cpp): `VGF/src/VGF/Audio.cpp`

### Assets and effects

- [Materials](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Material.cpp): `VGF/src/VGF/Material.cpp`
- [Textures](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Texture.cpp): `VGF/src/VGF/Texture.cpp`
- [Resources](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Resource.cpp): `VGF/src/VGF/Resource.cpp`
- [Text and fonts](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/TextManager.cpp): `VGF/src/VGF/TextManager.cpp`
- [Shader config](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Shader.cpp): `VGF/src/VGF/Shader.cpp`
- [Shader compiler](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/ShaderCompiler.cpp): `VGF/src/VGF/ShaderCompiler.cpp`

### Rendering

- [Renderer](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/Renderer.cpp): `VGF/src/VGF/Renderer.cpp`
- [Render data](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/RenderData.h): `VGF/src/VGF/RenderData.h`
- [Frame buffers](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/FrameBuffer.cpp): `VGF/src/VGF/FrameBuffer.cpp`

### Graphics backends

- [OpenGL backend](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/opengl/OpenGLManager.cpp): `VGF/src/VGF/graphicsApi/opengl/OpenGLManager.cpp`
- [OpenGL GUI](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/opengl/OpenglGui.cpp): `VGF/src/VGF/graphicsApi/opengl/OpenglGui.cpp`
- [Vulkan backend](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanManager.cpp): `VGF/src/VGF/graphicsApi/vulkan/VulkanManager.cpp`
- [Vulkan pipeline](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanGraphicsPipeline.cpp): `VGF/src/VGF/graphicsApi/vulkan/VulkanGraphicsPipeline.cpp`
- [Vulkan frame buffer](https://github.com/saltzus/vgframe/blob/master/VGF/src/VGF/graphicsApi/vulkan/VulkanFrameBuffer.cpp): `VGF/src/VGF/graphicsApi/vulkan/VulkanFrameBuffer.cpp`

### Other components

- **Application**

## Connections

- Application → Window: creates
- Application → Models: loads models
- Application → Physics: uses simulation
- Window → Renderer: initializes graphics
- Input → GUI: integrates input (evidence: `VGF/src/VGF/Input.cpp`)
- Input → Physics: references physics (evidence: `VGF/src/VGF/Input.cpp`)
- Models → Materials: uses materials
- Materials → Textures: references textures
- Models → Physics: references physics (evidence: `VGF/src/VGF/Model.cpp`)
- Physics → Physics debug: references renderer
- Models → Renderer: uses renderer
- Models → Render data: owns render data
- Renderer → Shader config: accepts shader
- Renderer → Camera: uses camera
- Shader config → Shader compiler: uses compiler
- Shader config → Resources: uses resources
- Renderer → OpenGL backend: selects backend
- Renderer → Vulkan backend: selects backend
- OpenGL backend → OpenGL GUI: GUI implementation
- Vulkan backend → Vulkan pipeline: creates pipelines
- Vulkan backend → Vulkan frame buffer: uses frame buffers
- GUI → OpenGL GUI: backend implementation (evidence: `VGF/src/VGF/Gui.cpp`)
- GUI → Vulkan backend: backend implementation (evidence: `VGF/src/VGF/Gui.cpp`)
- Text and fonts → Resources: references resources (evidence: `VGF/src/VGF/TextManager.cpp`)
