# whynotmake-it/flutter_liquid_glass architecture

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

- Interactive diagram: https://gitdiagram.com/whynotmake-it/flutter_liquid_glass
- Repository: https://github.com/whynotmake-it/flutter_liquid_glass

## Overview

##### Project type and purpose
- This is a Flutter-based monorepo of two related Dart packages, managed with Melos:
- **liquid_glass_renderer**: a core Flutter package providing liquid‐glass rendering via custom shaders and widgets.
- **apple_liquid_glass**: a thin wrapper that re-exports the core renderer for Apple‐specific use (currently WIP).
- An **example** Flutter app demonstrates usage of the renderer.

##### File structure
- Top‐level:
- **melos.yaml** – orchestrates workspace commands across packages (versioning, publishing, test runs).
- **.github/workflows** – CI pipelines (build, test, tag‐release).
- **packages/** – two subpackages.
- **liquid_glass_renderer/**:
- **lib/assets/shaders/** – GLSL fragment shaders (liquid_glass.frag, etc).
- **test/** – unit/golden tests verifying rendering correctness.
- **apple_liquid_glass/**:
- minimal structure exporting the core library.

##### README for additional insights
- The README confirms this is a **workspace** of two interdependent Flutter packages.

a. Main components:
- Developer & CI (Melos) – workspace orchestration, versioning, publishing.
- Core Package: **liquid_glass_renderer**
– Assets: GLSL shader files loaded at runtime.
– Tests: unit and golden image tests.
- Wrapper Package: **apple_liquid_glass** (depends_on → liquid_glass_renderer)
- Example App: depends_on both packages; runs on Flutter desktop/mobile.
- External Services: pub.dev (package hosting), GitHub Actions (CI).
b. Relationships & data flow:
- Developer (IDE/CLI) → invokes Melos → runs build/test/publish on each package.
- Example App → imports apple_liquid_glass AND liquid_glass_renderer → at runtime loads shaders → Flutter engine & GPU.
- CI workflows trigger Melos scripts on push/tag → run tests in each package → publish on version bump.
c. Architectural patterns & design principles:
- Monorepo modularity via **Melos**: share common scripts, enforce version consistency.
- Separation of concerns: core rendering logic (renderer), platform-specific exports (apple).
- Asset-driven shader pipeline: GLSL files are first-class assets.
- Example app for integration verification.
d. Technologies & frameworks:
- Dart & Flutter (rendering surface, widget tree)
- Melos (monorepo management)
- GitHub Actions (CI/CD)
- GLSL (shader code)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer and CI
    Developer["Developer (IDE/CLI)"]:::dev
    CI["GitHub Actions"]:::ci
    Developer -->|"push/tag"| CI
    CI -->|triggers Melos| Melos

    %% Monorepo Workspace
    subgraph "Monorepo Workspace"
        Melos["Melos Workspace"]:::ci
        RepoRoot["melos.yaml"]:::ci
    end
    click RepoRoot "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/melos.yaml"
    CI -->|runs workflows| W1
    CI -->|runs workflows| W2
    CI -->|runs workflows| W3

    %% CI Workflows
    subgraph "CI/CD Workflows"
        W1["main.yaml"]:::ci
        W2["tag-release.yaml"]:::ci
        W3["version.yaml"]:::ci
    end
    click W1 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/.github/workflows/main.yaml"
    click W2 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/.github/workflows/tag-release.yaml"
    click W3 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/.github/workflows/version.yaml"

    %% Core Package
    subgraph "liquid_glass_renderer (Core Package)"
        RootCore["packages/liquid_glass_renderer/"]:::core
        PublicAPI["liquid_glass_renderer.dart"]:::core
        click PublicAPI "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/liquid_glass_renderer.dart"

        subgraph "Dart Modules"
            LG["liquid_glass.dart"]:::core
            GF["glassify.dart"]:::core
            LL["liquid_glass_layer.dart"]:::core
            LS["liquid_glass_settings.dart"]:::core
            SH["liquid_shape.dart"]:::core
            RS["raw_shapes.dart"]:::core
            SD["shaders.dart"]:::core
        end
        click LG "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/liquid_glass.dart"
        click GF "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/glassify.dart"
        click LL "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/liquid_glass_layer.dart"
        click LS "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/liquid_glass_settings.dart"
        click SH "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/liquid_shape.dart"
        click RS "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/raw_shapes.dart"
        click SD "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/src/shaders.dart"

        subgraph "Shader Assets"
            F1["liquid_glass.frag"]:::asset
            F2["liquid_glass_arbitrary.frag"]:::asset
            F3["shared.glsl"]:::asset
        end
        click F1 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/assets/shaders/liquid_glass.frag"
        click F2 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/assets/shaders/liquid_glass_arbitrary.frag"
        click F3 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/lib/assets/shaders/shared.glsl"

        subgraph "Tests"
            T1["flutter_test_config.dart"]:::test
            T2["glassify_test.dart"]:::test
            T3["liquid_glass_test.dart"]:::test
            T4["shared.dart"]:::test
        end
        click T1 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/test/flutter_test_config.dart"
        click T2 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/test/src/glassify_test.dart"
        click T3 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/test/src/liquid_glass_test.dart"
        click T4 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/test/src/shared.dart"
    end

    %% Wrapper Package
    subgraph "apple_liquid_glass (Wrapper Package)"
        RootWrapper["packages/apple_liquid_glass/"]:::wrapper
        API_APP["apple_liquid_glass.dart"]:::wrapper
        click API_APP "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/apple_liquid_glass/lib/apple_liquid_glass.dart"
        spec_app["pubspec.yaml"]:::wrapper
        click spec_app "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/apple_liquid_glass/pubspec.yaml"
    end

    %% Example Application
    subgraph "Example App"
        RootEx["packages/liquid_glass_renderer/example/"]:::example
        main["main.dart"]:::example
        click main "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/lib/main.dart"
        clk["clock.dart"]:::example
        click clk "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/lib/clock.dart"
        gr["grid.dart"]:::example
        click gr "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/lib/grid.dart"
        shEx["shapes.dart"]:::example
        click shEx "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/lib/shapes.dart"
        shEx2["shared.dart"]:::example
        click shEx2 "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/lib/shared.dart"
        spec_ex["pubspec.yaml"]:::example
        click spec_ex "https://github.com/whynotmake-it/flutter_liquid_glass/blob/main/packages/liquid_glass_renderer/example/pubspec.yaml"
    end

    %% External Services
    FlutterEngine["Flutter Engine & GPU"]:::external
    PubDev["pub.dev"]:::external

    %% Relationships
    Melos -->|manages| RootCore
    Melos -->|manages| RootWrapper
    Melos -->|manages| RootEx
    API_APP -->|depends_on| PublicAPI
    main -->|imports| PublicAPI
    main -->|imports| API_APP
    main -->|renders_on| FlutterEngine
    PublicAPI -->|loads| F1
    PublicAPI -->|loads| F2
    PublicAPI -->|loads| F3
    Melos -->|publishes| PubDev
    CI -->|publishes| PubDev

    %% Styles
    classDef core fill:#D0E0FF,stroke:#036,stroke-width:1px
    classDef asset fill:#D0FFD8,stroke:#060,stroke-width:1px
    classDef wrapper fill:#FFE0CC,stroke:#C60,stroke-width:1px
    classDef example fill:#FFF0B0,stroke:#C90,stroke-width:1px
    classDef ci fill:#E8D0FF,stroke:#609,stroke-width:1px
    classDef dev fill:#F0F0F0,stroke:#888,stroke-width:1px
    classDef external fill:#E0E0E0,stroke:#666,stroke-width:1px
    classDef test fill:#F8D0E0,stroke:#C33,stroke-width:1px
```
