# studiocherno/walnut architecture

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

- Interactive diagram: https://gitdiagram.com/studiocherno/walnut
- Repository: https://github.com/studiocherno/walnut

## Overview

Walnut is a C++ desktop application framework combining Dear ImGui UI with Vulkan rendering. The principal workflow is a client-defined application launched through Walnut’s entry point, initialized and run by the framework, with layers providing app UI; images can be uploaded as Vulkan textures. The README also describes real-time Vulkan rendering alongside UI. Sampled sources show input polling, image upload, and random utilities. Several implementation details are unsampled, so only documented or visible relationships are shown.

Main entry points: [`Walnut/src/Walnut/Application.cpp`](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp) (Application runtime), [`Walnut/src/Walnut/Image.cpp`](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Image.cpp) (Image textures), [`WalnutApp/src/WalnutApp.cpp`](https://github.com/studiocherno/walnut/blob/master/WalnutApp/src/WalnutApp.cpp) (Client application), [`Walnut/src/Walnut/Application.h`](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.h) (Application API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_launch["Application launch"]
  node_entry["Entry point<br/>[EntryPoint.h]"]
  node_client["Client application<br/>[WalnutApp.cpp]"]
end

subgraph group_runtime["Framework runtime"]
  node_app["Application runtime<br/>[Application.cpp]"]
  node_app_api["Application API<br/>[Application.h]"]
  node_layer["Layer interface<br/>[Layer.h]"]
  node_input["Input polling<br/>[Input.cpp]"]
  node_keycodes["Input codes<br/>[KeyCodes.h]"]
end

subgraph group_graphics["UI and graphics"]
  node_imgui["Dear ImGui UI<br/>[Application.cpp]"]
  node_vulkan["Vulkan renderer<br/>[Application.cpp]"]
  node_image["Image textures<br/>[Image.cpp]"]
  node_imgui_build["ImGui backend build<br/>[ImGuiBuild.cpp]"]
end

subgraph group_utilities["App utilities"]
  node_random["Random utilities<br/>[Random.h]"]
  node_timer["Timer utility<br/>[Timer.h]"]
end

node_user(("App user"))
node_glfw["GLFW window/input"]
node_vulkan_sdk["Vulkan API"]
node_stb["stb_image decoder"]

node_user -->|"creates app"| node_client
node_entry -->|"calls factory"| node_client
node_client -->|"constructs"| node_app
node_client -->|"pushes layer"| node_layer
node_app -->|"implements"| node_app_api
node_app_api -->|"manages layers"| node_layer
node_app -->|"creates window"| node_glfw
node_input -->|"gets window"| node_app_api
node_input -->|"polls input"| node_glfw
node_input -->|"uses codes"| node_keycodes
node_app -->|"renders UI"| node_imgui
node_app -->|"submits frames"| node_vulkan
node_image -->|"uses device"| node_app_api
node_image -->|"uploads textures"| node_vulkan
node_image -->|"registers texture"| node_imgui
node_image -->|"decodes files"| node_stb
node_vulkan -->|"calls API"| node_vulkan_sdk

click node_entry "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/EntryPoint.h"
click node_client "https://github.com/studiocherno/walnut/blob/master/WalnutApp/src/WalnutApp.cpp"
click node_app "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp"
click node_app_api "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.h"
click node_layer "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Layer.h"
click node_input "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Input/Input.cpp"
click node_keycodes "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Input/KeyCodes.h"
click node_imgui "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp"
click node_vulkan "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp"
click node_image "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Image.cpp"
click node_imgui_build "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/ImGui/ImGuiBuild.cpp"
click node_random "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Random.h"
click node_timer "https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Timer.h"

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_entry,node_client,node_user toneBlue
class node_app,node_app_api,node_layer,node_input,node_keycodes toneAmber
class node_imgui,node_vulkan,node_image,node_imgui_build,node_vulkan_sdk toneMint
class node_random,node_timer toneRose
class node_glfw,node_stb toneIndigo
```

## Components

### Application launch

- [Entry point](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/EntryPoint.h): `Walnut/src/Walnut/EntryPoint.h`
- [Client application](https://github.com/studiocherno/walnut/blob/master/WalnutApp/src/WalnutApp.cpp): `WalnutApp/src/WalnutApp.cpp`

### Framework runtime

- [Application runtime](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp): `Walnut/src/Walnut/Application.cpp`
- [Application API](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.h): `Walnut/src/Walnut/Application.h`
- [Layer interface](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Layer.h): `Walnut/src/Walnut/Layer.h`
- [Input polling](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Input/Input.cpp): `Walnut/src/Walnut/Input/Input.cpp`
- [Input codes](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Input/KeyCodes.h): `Walnut/src/Walnut/Input/KeyCodes.h`

### UI and graphics

- [Dear ImGui UI](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp): `Walnut/src/Walnut/Application.cpp`
- [Vulkan renderer](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Application.cpp): `Walnut/src/Walnut/Application.cpp`
- [Image textures](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Image.cpp): `Walnut/src/Walnut/Image.cpp`
- [ImGui backend build](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/ImGui/ImGuiBuild.cpp): `Walnut/src/Walnut/ImGui/ImGuiBuild.cpp`

### App utilities

- [Random utilities](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Random.h): `Walnut/src/Walnut/Random.h`
- [Timer utility](https://github.com/studiocherno/walnut/blob/master/Walnut/src/Walnut/Timer.h): `Walnut/src/Walnut/Timer.h`

### Other components

- **App user**
- **GLFW window/input**
- **Vulkan API**
- **stb_image decoder**

## Connections

- App user → Client application: creates app (evidence: `README.md`)
- Entry point → Client application: calls factory (evidence: `Walnut/src/Walnut/EntryPoint.h`)
- Client application → Application runtime: constructs (evidence: `WalnutApp/src/WalnutApp.cpp`)
- Client application → Layer interface: pushes layer (evidence: `WalnutApp/src/WalnutApp.cpp`)
- Application runtime → Application API: implements (evidence: `Walnut/src/Walnut/Application.cpp`)
- Application API → Layer interface: manages layers (evidence: `Walnut/src/Walnut/Application.h`)
- Application runtime → GLFW window/input: creates window (evidence: `Walnut/src/Walnut/Application.cpp`)
- Input polling → Application API: gets window (evidence: `Walnut/src/Walnut/Input/Input.cpp`)
- Input polling → GLFW window/input: polls input (evidence: `Walnut/src/Walnut/Input/Input.cpp`)
- Input polling → Input codes: uses codes
- Application runtime → Dear ImGui UI: renders UI (evidence: `Walnut/src/Walnut/Application.cpp`)
- Application runtime → Vulkan renderer: submits frames (evidence: `Walnut/src/Walnut/Application.cpp`)
- Image textures → Application API: uses device (evidence: `Walnut/src/Walnut/Image.cpp`)
- Image textures → Vulkan renderer: uploads textures (evidence: `Walnut/src/Walnut/Image.cpp`)
- Image textures → Dear ImGui UI: registers texture (evidence: `Walnut/src/Walnut/Image.cpp`)
- Image textures → stb_image decoder: decodes files (evidence: `Walnut/src/Walnut/Image.cpp`)
- Vulkan renderer → Vulkan API: calls API (evidence: `Walnut/src/Walnut/Application.cpp`)
