# d-itu/sdf-view architecture

> Architecture diagram of the GitHub repository d-itu/sdf-view, 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/d-itu/sdf-view
- Repository: https://github.com/d-itu/sdf-view

## Overview

sdf-view accepts a user-authored GLSL signed-distance function and renders it either to a PNG or an interactive desktop preview. The CLI parses render settings and selects offline or preview mode; offline rendering reads the shader, invokes the library renderer, and writes PNG output. Preview mode adds window and input handling, interactive camera controls, and shader reloads. The library validates scene settings and builds a GPU pipeline for rendering. Source excerpts show the main render and preview paths; some shader details and preview setup are documented but not fully sampled.

Main entry points: [`cli/src/main.rs`](https://github.com/d-itu/sdf-view/blob/main/cli/src/main.rs) (CLI entry), [`cli/src/interactive.rs`](https://github.com/d-itu/sdf-view/blob/main/cli/src/interactive.rs) (Preview loop), [`src/lib.rs`](https://github.com/d-itu/sdf-view/blob/main/src/lib.rs) (Renderer API), [`src/pipeline.rs`](https://github.com/d-itu/sdf-view/blob/main/src/pipeline.rs) (Scene pipeline)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI and output"]
  node_cli["CLI entry<br/>[main.rs]"]
  node_cli_errors["CLI errors<br/>[error.rs]"]
end

subgraph group_preview["Interactive preview"]
  node_preview["Preview loop<br/>[interactive.rs]"]
end

subgraph group_engine["Render library"]
  node_scene["Camera and lighting<br/>[scene.rs]"]
  node_renderer["Renderer API<br/>[lib.rs]"]
  node_render_errors["Render errors<br/>[error.rs]"]
end

subgraph group_gpu["GPU rendering"]
  node_pipeline["Scene pipeline<br/>[pipeline.rs]"]
  node_shaders["Render shaders"]
end

node_user(("User"))
node_shader_file["GLSL input"]
node_desktop["Desktop system"]
node_graphics["Graphics driver"]
node_png_file["PNG output"]

node_user -->|"runs"| node_cli
node_user -->|"provides"| node_shader_file
node_cli -->|"reads"| node_shader_file
node_cli -->|"selects preview"| node_preview
node_cli -->|"renders offline"| node_renderer
node_cli -->|"writes PNG"| node_png_file
node_cli -->|"converts errors"| node_cli_errors
node_preview -->|"opens window"| node_desktop
node_preview -->|"reloads"| node_shader_file
node_preview -->|"creates renderer"| node_renderer
node_preview -->|"compiles and draws"| node_pipeline
node_user -->|"controls camera"| node_preview
node_renderer -->|"validates settings"| node_scene
node_renderer -->|"builds and draws"| node_pipeline
node_renderer -->|"returns errors"| node_render_errors
node_pipeline -->|"uses GPU"| node_graphics
node_pipeline -.->|"loads shader code"| node_shaders

click node_cli "https://github.com/d-itu/sdf-view/blob/main/cli/src/main.rs"
click node_cli_errors "https://github.com/d-itu/sdf-view/blob/main/cli/src/error.rs"
click node_preview "https://github.com/d-itu/sdf-view/blob/main/cli/src/interactive.rs"
click node_scene "https://github.com/d-itu/sdf-view/blob/main/src/scene.rs"
click node_renderer "https://github.com/d-itu/sdf-view/blob/main/src/lib.rs"
click node_render_errors "https://github.com/d-itu/sdf-view/blob/main/src/error.rs"
click node_pipeline "https://github.com/d-itu/sdf-view/blob/main/src/pipeline.rs"
click node_shaders "https://github.com/d-itu/sdf-view/tree/main/src/shaders"

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_cli,node_cli_errors,node_user toneBlue
class node_preview toneAmber
class node_scene,node_renderer,node_render_errors toneMint
class node_pipeline,node_shaders toneRose
class node_shader_file,node_desktop,node_graphics,node_png_file toneIndigo
```

## Components

### CLI and output

- [CLI entry](https://github.com/d-itu/sdf-view/blob/main/cli/src/main.rs): `cli/src/main.rs`
- [CLI errors](https://github.com/d-itu/sdf-view/blob/main/cli/src/error.rs): `cli/src/error.rs`

### Interactive preview

- [Preview loop](https://github.com/d-itu/sdf-view/blob/main/cli/src/interactive.rs): `cli/src/interactive.rs`

### Render library

- [Camera and lighting](https://github.com/d-itu/sdf-view/blob/main/src/scene.rs): `src/scene.rs`
- [Renderer API](https://github.com/d-itu/sdf-view/blob/main/src/lib.rs): `src/lib.rs`
- [Render errors](https://github.com/d-itu/sdf-view/blob/main/src/error.rs): `src/error.rs`

### GPU rendering

- [Scene pipeline](https://github.com/d-itu/sdf-view/blob/main/src/pipeline.rs): `src/pipeline.rs`
- [Render shaders](https://github.com/d-itu/sdf-view/tree/main/src/shaders): `src/shaders`

### Other components

- **User**
- **GLSL input**
- **Desktop system**
- **Graphics driver**
- **PNG output**

## Connections

- User → CLI entry: runs (evidence: `README.md`)
- User → GLSL input: provides (evidence: `README.md`)
- CLI entry → GLSL input: reads (evidence: `cli/src/main.rs`)
- CLI entry → Preview loop: selects preview (evidence: `cli/src/main.rs`)
- CLI entry → Renderer API: renders offline (evidence: `cli/src/main.rs`)
- CLI entry → PNG output: writes PNG (evidence: `cli/src/main.rs`)
- CLI entry → CLI errors: converts errors (evidence: `cli/src/main.rs`)
- Preview loop → Desktop system: opens window (evidence: `README.md`)
- Preview loop → GLSL input: reloads (evidence: `cli/src/interactive.rs`)
- Preview loop → Renderer API: creates renderer (evidence: `cli/src/interactive.rs`)
- Preview loop → Scene pipeline: compiles and draws (evidence: `cli/src/interactive.rs`)
- User → Preview loop: controls camera (evidence: `README.md`)
- Renderer API → Camera and lighting: validates settings (evidence: `src/lib.rs`)
- Renderer API → Scene pipeline: builds and draws (evidence: `src/lib.rs`)
- Renderer API → Render errors: returns errors (evidence: `src/lib.rs`)
- Scene pipeline → Graphics driver: uses GPU (evidence: `README.md`)
- Scene pipeline → Render shaders: loads shader code
