# deankjones/optics architecture

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

- Interactive diagram: https://gitdiagram.com/deankjones/optics
- Repository: https://github.com/deankjones/optics

## Overview

##### Project Type Analysis
This is a specialized graphics application focusing on wave optics simulation using WebGPU. The project structure indicates a modern web application with GPU computation capabilities, specifically designed for physics simulations.

##### Main Components

A. Application Layer
- Entry Point (main.ts)
- Application Core (app.ts)
- Styling (style.css)

B. Rendering System
- Renderer Core
- Buffer Management
- Pipeline Management
- Shader Programs

C. GPU Computation Layer
- Compute Kernels
- Shader Programs

**[Browser Environment]**
- ↓
**[Application Layer] → [WebGPU Context]**
- ↓
- [Renderer]
- ↙        ↘
**[Buffers]    [Pipelines]**
- ↓            ↓
**[GPU Shaders & Compute Kernels]**

##### Detailed Component Relationships

a) Application Layer (Top):
- Main Entry Point
- App Controller
- HTML Canvas Element

b) Renderer System (Middle):
- Buffer Manager
- Screen Buffer
- Uniform Buffer
- Pipeline Manager
- Compute Pipeline
- Screen Pipeline
- Layout Managers

c) GPU Layer (Bottom):
- Compute Kernel (computeKernel.wgsl)
- Screen Shader (screenShader.wgsl)

##### Data Flow Indicators

- Data flow from application to GPU
- Render pipeline flow
- Compute pipeline flow
- Buffer data movement

##### Component Details

Specific elements:
- WebGPU Pipeline States
- Buffer Descriptions
- Uniform Buffer Settings
- Shader Entry Points
- Compute Kernel Configuration

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Browser
        Canvas["HTML Canvas Element"]
    end

    subgraph AppLayer["Application Layer"]
        Main["Main Entry Point"]:::app
        App["App Controller"]:::app
        Style["Styling"]:::app
    end

    subgraph RenderSystem["Renderer System"]
        Renderer["Renderer Core"]:::renderer
        
        subgraph BufferMgmt["Buffer Management"]
            BufferManager["Buffer Manager"]:::buffer
            ScreenBuffer["Screen Buffer"]:::buffer
            UniformBuffer["Uniform Buffer"]:::buffer
            UniformSettings["Uniform Settings"]:::buffer
        end
        
        subgraph PipelineMgmt["Pipeline Management"]
            PipelineManager["Pipeline Manager"]:::pipeline
            ComputePipeline["Compute Pipeline"]:::pipeline
            ScreenPipeline["Screen Pipeline"]:::pipeline
        end
    end

    subgraph GPULayer["GPU Layer"]
        ComputeKernel["Compute Kernel"]:::gpu
        ScreenShader["Screen Shader"]:::gpu
    end

    %% Connections
    Browser --> AppLayer
    Main --> App
    App --> Renderer
    Renderer --> BufferManager
    Renderer --> PipelineManager
    
    BufferManager --> ScreenBuffer
    BufferManager --> UniformBuffer
    UniformBuffer --> UniformSettings
    
    PipelineManager --> ComputePipeline
    PipelineManager --> ScreenPipeline
    
    ComputePipeline --> ComputeKernel
    ScreenPipeline --> ScreenShader

    %% Click Events
    click Main "https://github.com/DeanKJones/Optics/blob/master/src/main.ts"
    click App "https://github.com/DeanKJones/Optics/blob/master/src/app.ts"
    click Style "https://github.com/DeanKJones/Optics/blob/master/src/style.css"
    click Renderer "https://github.com/DeanKJones/Optics/blob/master/src/render/renderer.ts"
    click BufferManager "https://github.com/DeanKJones/Optics/blob/master/src/render/buffers/bufferManager.ts"
    click PipelineManager "https://github.com/DeanKJones/Optics/blob/master/src/render/pipelines/pipelineManager.ts"
    click ScreenBuffer "https://github.com/DeanKJones/Optics/blob/master/src/render/buffers/screenBufferDescription.ts"
    click UniformBuffer "https://github.com/DeanKJones/Optics/blob/master/src/render/buffers/uniformBufferDescription.ts"
    click ComputePipeline "https://github.com/DeanKJones/Optics/blob/master/src/render/pipelines/computePipelineDescription.ts"
    click ScreenPipeline "https://github.com/DeanKJones/Optics/blob/master/src/render/pipelines/screenPipelineDescription.ts"
    click UniformSettings "https://github.com/DeanKJones/Optics/blob/master/src/render/layouts/uniformBufferSettings.ts"
    click ComputeKernel "https://github.com/DeanKJones/Optics/blob/master/src/gpu/shaders/computeKernel.wgsl"
    click ScreenShader "https://github.com/DeanKJones/Optics/blob/master/src/gpu/shaders/screenShader.wgsl"

    %% Styles
    classDef app fill:#3498db,stroke:#2980b9,color:white
    classDef renderer fill:#2ecc71,stroke:#27ae60,color:white
    classDef buffer fill:#9b59b6,stroke:#8e44ad,color:white
    classDef pipeline fill:#e67e22,stroke:#d35400,color:white
    classDef gpu fill:#e74c3c,stroke:#c0392b,color:white

    %% Legend
    subgraph Legend
        AppComp["Application Component"]:::app
        RenderComp["Renderer Component"]:::renderer
        BufferComp["Buffer Component"]:::buffer
        PipelineComp["Pipeline Component"]:::pipeline
        GPUComp["GPU Component"]:::gpu
    end
```
