# marcefrasson/minirt architecture

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

- Interactive diagram: https://gitdiagram.com/marcefrasson/minirt
- Repository: https://github.com/marcefrasson/minirt

## Overview

##### Project type and purpose
- This is a standalone, single‐process, full‐monolith C application: a ray‐tracer that reads a simple scene description file, builds an in‐memory representation of primitives (spheres, planes, etc.), performs ray‐casting with Phong shading, and outputs to a window (via MiniLibX) or to a bitmap.

##### File structure
- Top‐level:
- Makefile, install scripts, README – build & install logic
- libs: `libft` (common C helpers), `install_mlx.sh` (MiniLibX installer)
- `parsing/` – scene‐file lexer & parser
- `render/` – ray‐tracer core (ray generation, intersection, shading, window/bitmap)
- `utils/` – vector algebra primitives
- `scenes/` – example scene files (.rt)

a. CLI Launcher
- Entrypoint (`miniRT` main)
- Handles arguments and kicks off parsing
b. Parser Module (`parsing/`)
- Reads .rt file
- Tokenizes lines, validates syntax
- Produces in‐memory Scene data structure (cameras, lights, objects)
c. Core Data Structures (in `includes/miniRT.h`)
d. Vector Math Utilities (`utils/`)
- Vector add, subtract, dot/cross, normalize, scale
e. Rendering Engine (`render/`)
- Ray generator (per pixel)
- Shading (Phong: ambient + diffuse + specular + reflection)
- Secondary rays (reflection recursion)
f. Output Modules
- Bitmap writer (`render/bitmap.c`): export .bmp file
g. External Libraries
- libft – core C utilities (strings, lists, memory)
- MiniLibX – lightweight graphics API

##### Relationships and data flows
- CLI → Parser: passes scene file path
- Parser → Core Data Structures: populates Scene struct
- Scene + Camera + Utils → Rendering Engine: per‐pixel ray generation
- Rendering Engine → Intersection & Shading modules → Framebuffer
- Framebuffer → Output Module (Window or Bitmap) → OS/Display

##### Architectural patterns & design principles
- Layered modular structure: Parser → Core data → Renderer → Output
- Single responsibility per module/directory
- Reusable utility library (`libft`) separated from domain logic
- Data‐oriented design: scene stored in plain structs, passed to pure functions

[ ] Clear module/component names matching directory names
[ ] Notes on key technologies: C, libft, MiniLibX
[ ] Detailed annotation of the Render Pipeline stages

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Launcher
    CLI["CLI Launcher\nminiRT (main)"]:::cli
    click CLI "https://github.com/marcefrasson/minirt/blob/master/parsing/miniRT.c"

    %% Parser Module
    subgraph "Parser Module" 
        direction TB
        Parser["Parser Module"]:::parsing
        ParsingI["parsing_I.c"]:::parsing
        ParsingII["parsing_II.c"]:::parsing
        ParsingIII["parsing_III.c"]:::parsing
        UtilsI["parsing_utils_I.c"]:::parsing
        UtilsII["parsing_utils_II.c"]:::parsing
        click ParsingI "https://github.com/marcefrasson/minirt/blob/master/parsing/parsing_I.c"
        click ParsingII "https://github.com/marcefrasson/minirt/blob/master/parsing/parsing_II.c"
        click ParsingIII "https://github.com/marcefrasson/minirt/blob/master/parsing/parsing_III.c"
        click UtilsI "https://github.com/marcefrasson/minirt/blob/master/parsing/parsing_utils_I.c"
        click UtilsII "https://github.com/marcefrasson/minirt/blob/master/parsing/parsing_utils_II.c"
    end

    %% Core Data Structures
    CoreData["Core Data Structures\n(miniRT.h)"]:::core
    click CoreData "https://github.com/marcefrasson/minirt/blob/master/includes/miniRT.h"

    %% Utils Module
    subgraph "Vector Math Utilities"
        direction TB
        Vec1["vector_oper_I.c"]:::utils
        Vec2["vector_oper_II.c"]:::utils
        Vec3["vector_oper_III.c"]:::utils
        click Vec1 "https://github.com/marcefrasson/minirt/blob/master/utils/vector_oper_I.c"
        click Vec2 "https://github.com/marcefrasson/minirt/blob/master/utils/vector_oper_II.c"
        click Vec3 "https://github.com/marcefrasson/minirt/blob/master/utils/vector_oper_III.c"
    end

    %% Rendering Engine
    subgraph "Rendering Engine"
        direction TB
        RayGen1["ray_tracer_I.c"]:::render
        RayGen2["ray_tracer_II.c"]:::render
        RayGen3["ray_tracer_III.c"]:::render
        Inter1["obj_intersec_I.c"]:::render
        Inter2["obj_intersec_II.c"]:::render
        Inter3["obj_intersec_III.c"]:::render
        Check1["check_elem_I.c"]:::render
        Check2["check_elem_II.c"]:::render
        Check3["check_elem_III.c"]:::render
        Phong["phong.c"]:::render
        click RayGen1 "https://github.com/marcefrasson/minirt/blob/master/render/ray_tracer_I.c"
        click RayGen2 "https://github.com/marcefrasson/minirt/blob/master/render/ray_tracer_II.c"
        click RayGen3 "https://github.com/marcefrasson/minirt/blob/master/render/ray_tracer_III.c"
        click Inter1 "https://github.com/marcefrasson/minirt/blob/master/render/obj_intersec_I.c"
        click Inter2 "https://github.com/marcefrasson/minirt/blob/master/render/obj_intersec_II.c"
        click Inter3 "https://github.com/marcefrasson/minirt/blob/master/render/obj_intersec_III.c"
        click Check1 "https://github.com/marcefrasson/minirt/blob/master/render/check_elem_I.c"
        click Check2 "https://github.com/marcefrasson/minirt/blob/master/render/check_elem_II.c"
        click Check3 "https://github.com/marcefrasson/minirt/blob/master/render/check_elem_III.c"
        click Phong "https://github.com/marcefrasson/minirt/blob/master/render/phong.c"
    end

    %% Output Modules
    subgraph "Output Modules"
        direction TB
        Window["window.c"]:::output
        Bitmap["bitmap.c"]:::output
        click Window "https://github.com/marcefrasson/minirt/blob/master/render/window.c"
        click Bitmap "https://github.com/marcefrasson/minirt/blob/master/render/bitmap.c"
    end

    %% External Libraries
    subgraph "External Libraries"
        direction TB
        Libft["libft/"]:::external
        MLX["install_mlx.sh"]:::external
        click Libft "https://github.com/marcefrasson/minirt/tree/master/libft/"
        click MLX "https://github.com/marcefrasson/minirt/blob/master/install_mlx.sh"
    end

    %% Example Scenes
    Scenes["Example Scenes (.rt)"]:::scenes
    click Scenes "https://github.com/marcefrasson/minirt/blob/master/scenes/*.rt"

    %% Connections
    CLI -->|reads .rt file| Parser
    Parser -->|Scene struct| CoreData
    CoreData -->|uses| Vec1
    CoreData -->|uses| Vec2
    CoreData -->|uses| Vec3
    Parser -->|populates| CoreData
    CoreData -->|provides data| RayGen1
    Vec1 -->|vector ops| RayGen1
    Vec2 -->|vector ops| RayGen1
    Vec3 -->|vector ops| RayGen1
    RayGen1 -->|rays| Inter1
    Inter1 -->|hits| Phong
    Phong -->|shades| Bitmap
    Phong -->|shades| Window
    Bitmap -->|writes BMP| Scenes
    Window -->|renders| MLX
    Libft -->|utilities| CLI

    %% Styles
    classDef cli fill:#FFD700,stroke:#333,stroke-width:1px;
    classDef parsing fill:#87CEFA,stroke:#333,stroke-width:1px;
    classDef core fill:#D3D3D3,stroke:#333,stroke-width:1px;
    classDef utils fill:#FFFACD,stroke:#333,stroke-width:1px;
    classDef render fill:#98FB98,stroke:#333,stroke-width:1px;
    classDef output fill:#FFB6C1,stroke:#333,stroke-width:1px;
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px;
    classDef scenes fill:#E6E6FA,stroke:#333,stroke-width:1px;
```
