# fabric-project/satin architecture

> Architecture diagram of the GitHub repository fabric-project/satin, 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/fabric-project/satin
- Repository: https://github.com/fabric-project/satin

## Overview

##### Project type and purpose
- From the file tree and README, this is a Swift Package providing a 3D graphics framework (“Satin”) layered on top of Apple’s Metal API, plus an “Example” Xcode project demonstrating usage.
- Satin consists of two main deliverables:
- A Swift‐based framework (“Sources/Satin”) offering abstractions for meshes, materials, cameras, renderers, compute systems, pipelines, etc.
- A C/C++ core library (“Sources/SatinCore”) for performance‐critical geometry and computational tasks.
- The Example app (under “Example/Example”) is a SwiftUI (and UIKit/AppKit) demo that drives Satin to render scenes, AR content, UI controls, and pipelines in a real application.

##### File structure
- Top-level:
- .github/workflows: CI build
- Package.swift: Swift Package definition for Satin
- Satin.xcodeproj: local Xcode workspace for development & tests
- Sources/Satin: the Swift framework source
- Sources/SatinCore: the C/C++ core library
- Example: standalone Xcode demo app (with assets, UI, and renderer code)
- Scripts/build_xcframework: packaging script
- Tests: unit tests for both Satin and SatinCore
- Within Sources/Satin: modules by domain (AR, Animation, Buffers, Cameras, Geometry, Compute, Pipelines, Shaders, Utilities, Views, etc.), indicating a modular layered architecture.
- The Example app mirrors the framework’s modules for UI views (“Views/…”), controllers (“UI/…”), and demo renderers (“Renderers/…”), showing how consumers interact with the framework.

##### README for additional insights
- The README outlines
- The high-level API (Renderer, Context, Scene graph, Camera, Mesh, Material)
- Features: PBR, live coding, compute systems, BVH raycasting, ARKit integration, etc.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Example Application Layer
    subgraph "Example Application"
        ExampleApp["Example App"]:::swift
        ExampleAssets["Assets & Shaders"]:::swift
        ExampleRenderers["Demo Renderers"]:::swift
        ExampleViews["SwiftUI/UIKit Views"]:::swift
        ExampleUI["UI Controllers"]:::swift
        ExampleUtils["Utilities"]:::swift
    end

    %% Satin Swift Framework Layer
    subgraph "Satin Swift Framework"
        SatinSwift["Sources/Satin"]:::swift
        AR["AR Module"]:::swift
        Animation["Animation Module"]:::swift
        Buffers["Buffers Module"]:::swift
        CameraControllers["Camera Controllers"]:::swift
        Cameras["Cameras Module"]:::swift
        Compute["Compute Systems"]:::swift
        Constants["Constants"]:::swift
        CoreAPI["Core API"]:::swift
        Generators["Generators & Geometry"]:::swift
        Materials["Materials & Shaders"]:::swift
        Objects["Objects & Scene Graph"]:::swift
        Parameters["Parameter System"]:::swift
        Pipelines["Pipelines & Shaders"]:::swift
        Protocols["Protocols"]:::swift
        Raycasting["Raycasting"]:::swift
        RendererInternal["Renderer Internals"]:::swift
        Extensions["Extensions & Utilities"]:::swift
    end

    %% SatinCore C/C++ Layer
    subgraph "SatinCore C/C++ Library"
        SatinCore["SatinCore C/C++ Library"]:::ccore
        PublicHeaders["Public C Headers"]:::ccore
    end

    %% External Services Layer
    subgraph "External Apple Services"
        Metal["Metal API"]:::ext
        MetalKit["MetalKit/MPS"]:::ext
        UIFrameworks["SwiftUI/UIKit/AppKit"]:::ext
        ARKIT["ARKit"]:::ext
    end

    %% Relationships
    ExampleApp -->|"calls API"| CoreAPI
    ExampleApp -->|"uses"| ExampleAssets
    ExampleApp -->|"uses"| ExampleRenderers
    ExampleApp -->|"uses"| ExampleViews
    ExampleApp -->|"uses"| ExampleUI
    ExampleApp -->|"uses"| ExampleUtils
    ExampleApp -->|"UI via"| UIFrameworks

    CoreAPI -->|"bridges to"| SatinCore
    CoreAPI -->|"calls Metal"| Metal
    Compute -->|"dispatch compute shaders"| Metal
    Pipelines -->|"contains .metal shaders"| Metal
    AR -->|"uses ARKit"| ARKIT
    SatinSwift -->|"loads assets via"| MetalKit

    %% Click Events
    click ExampleApp "https://github.com/fabric-project/satin/tree/main/Example/Example"
    click ExampleAssets "https://github.com/fabric-project/satin/tree/main/Example/Assets"
    click ExampleRenderers "https://github.com/fabric-project/satin/tree/main/Example/Example/Renderers"
    click ExampleViews "https://github.com/fabric-project/satin/tree/main/Example/Example/Views"
    click ExampleUI "https://github.com/fabric-project/satin/tree/main/Example/Example/UI"
    click ExampleUtils "https://github.com/fabric-project/satin/tree/main/Example/Example/Utilities"
    click SatinSwift "https://github.com/fabric-project/satin/tree/main/Sources/Satin"
    click AR "https://github.com/fabric-project/satin/tree/main/Sources/Satin/AR"
    click Animation "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Animation"
    click Buffers "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Buffers"
    click CameraControllers "https://github.com/fabric-project/satin/tree/main/Sources/Satin/CameraControllers"
    click Cameras "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Cameras"
    click Compute "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Compute"
    click Constants "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Constants"
    click CoreAPI "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Core"
    click Generators "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Generators"
    click Generators "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Geometry"
    click Materials "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Materials"
    click Materials "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Shaders"
    click Objects "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Objects"
    click Parameters "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Parameters"
    click Pipelines "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Pipelines"
    click Protocols "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Protocols"
    click Raycasting "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Raycast"
    click RendererInternal "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Renderer"
    click Extensions "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Extensions"
    click Extensions "https://github.com/fabric-project/satin/tree/main/Sources/Satin/Utilities"
    click SatinCore "https://github.com/fabric-project/satin/tree/main/Sources/SatinCore"
    click PublicHeaders "https://github.com/fabric-project/satin/tree/main/Sources/SatinCore/include"
    click Scripts "https://github.com/fabric-project/satin/tree/main/Scripts/build_xcframework"
    click CI "https://github.com/fabric-project/satin/blob/main/ .github/workflows/build.yml"
    click Package "https://github.com/fabric-project/satin/blob/main/Package.swift"
    click XcodeProj "https://github.com/fabric-project/satin/blob/main/Satin.xcodeproj"

    %% Styles
    classDef swift fill:#BBDEFB,stroke:#1E88E5,stroke-width:1px
    classDef ccore fill:#C8E6C9,stroke:#2E7D32,stroke-width:1px
    classDef ext fill:#FFE0B2,stroke:#EF6C00,stroke-width:1px
```
