# hexops/mach architecture

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

- Interactive diagram: https://gitdiagram.com/hexops/mach
- Repository: https://github.com/hexops/mach

## Overview

##### Main Components Structure

a) Core System Layer
- Wayland and X11 subsystems for Linux
- Window management and system integration points

b) Graphics System (sysgpu)
- Multiple backend implementations:
- Direct3D 12
- Metal
- Vulkan
- OpenGL
- Shader compilation pipeline:
- WGSL Parser
- Code generators (GLSL, HLSL, MSL, SPIRV)

c) Audio System (sysaudio)
- Audio backend implementations:
- WASAPI (Windows)
- CoreAudio (macOS)
- ALSA/PulseAudio/PipeWire (Linux)
- JACK

d) Supporting Systems
- Math library (vectors, matrices, quaternions, collision)
- Time management
- Graphics utilities (Sprite, Text rendering)

##### Component Relationships

- Data flow between subsystems
- Dependency relationships
- API boundaries

Use the following visual elements:
- Double lines for API boundaries
- Blue: Core systems
- Green: Graphics
- Yellow: Audio
- Gray: Utilities

##### Detailed Subsystem Breakdown

For the graphics pipeline specifically:
**[Application] → [Core] → [sysgpu API] → [Backend-Specific Implementation] → [GPU Hardware]**

##### Technical Details

- API boundaries between:
- Application code
- Engine core
- Platform-specific implementations
- Graphics/Audio backends
- Resource management flow
- Async operations where relevant

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Core Component]:::core
        L2[Graphics Component]:::graphics
        L3[Audio Component]:::audio
        L4[Utility Component]:::utility
        L5[Platform Specific]:::platform
    end

    subgraph "Core System Layer"
        Core["Core System"]:::core
        
        subgraph "Platform Implementations"
            Windows["Windows"]:::platform
            Darwin["Darwin"]:::platform
            Linux["Linux"]:::platform
            
            subgraph "Linux Display Servers"
                Wayland["Wayland"]:::platform
                X11["X11"]:::platform
            end
        end
        
        Linux --> Wayland
        Linux --> X11
    end

    subgraph "Graphics System"
        SYSGPU["System GPU"]:::graphics
        
        subgraph "GPU Backends"
            D3D12["Direct3D 12"]:::graphics
            Metal["Metal"]:::graphics
            Vulkan["Vulkan"]:::graphics
            OpenGL["OpenGL"]:::graphics
        end
        
        subgraph "Shader Pipeline"
            Parser["WGSL Parser"]:::graphics
            
            subgraph "Code Generators"
                GLSL["GLSL Gen"]:::graphics
                HLSL["HLSL Gen"]:::graphics
                MSL["MSL Gen"]:::graphics
                SPIRV["SPIRV Gen"]:::graphics
            end
        end
        
        SYSGPU --> D3D12
        SYSGPU --> Metal
        SYSGPU --> Vulkan
        SYSGPU --> OpenGL
        
        Parser --> GLSL
        Parser --> HLSL
        Parser --> MSL
        Parser --> SPIRV
    end

    subgraph "Audio System"
        SYSAUDIO["System Audio"]:::audio
        
        subgraph "Audio Backends"
            WASAPI["WASAPI"]:::audio
            CoreAudio["CoreAudio"]:::audio
            ALSA["ALSA"]:::audio
            PulseAudio["PulseAudio"]:::audio
            PipeWire["PipeWire"]:::audio
            JACK["JACK"]:::audio
        end
        
        SYSAUDIO --> WASAPI
        SYSAUDIO --> CoreAudio
        SYSAUDIO --> ALSA
        SYSAUDIO --> PulseAudio
        SYSAUDIO --> PipeWire
        SYSAUDIO --> JACK
    end

    subgraph "Supporting Systems"
        subgraph "Math Library"
            Math["Math Core"]:::utility
            Vec["Vectors"]:::utility
            Mat["Matrices"]:::utility
            Quat["Quaternions"]:::utility
            Collision["Collision"]:::utility
        end
        
        subgraph "Time Management"
            Time["Time Core"]:::utility
            Timer["Timer"]:::utility
            Frequency["Frequency"]:::utility
        end
        
        subgraph "Graphics Utilities"
            GfxUtils["Graphics Utils"]:::utility
            Sprite["Sprite"]:::utility
            Text["Text"]:::utility
            Atlas["Atlas"]:::utility
        end
    end

    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef graphics fill:#4CAF50,stroke:#2E7D32,color:white
    classDef audio fill:#FFC107,stroke:#FFA000,color:black
    classDef utility fill:#9E9E9E,stroke:#616161,color:white
    classDef platform fill:#FF5722,stroke:#E64A19,color:white

    click Windows "https://github.com/hexops/mach/blob/main/src/core/Windows.zig"
    click Darwin "https://github.com/hexops/mach/blob/main/src/core/Darwin.zig"
    click Linux "https://github.com/hexops/mach/blob/main/src/core/Linux.zig"
    click Wayland "https://github.com/hexops/mach/blob/main/src/core/linux/Wayland.zig"
    click X11 "https://github.com/hexops/mach/blob/main/src/core/linux/X11.zig"
    click SYSGPU "https://github.com/hexops/mach/blob/main/src/sysgpu/main.zig"
    click D3D12 "https://github.com/hexops/mach/blob/main/src/sysgpu/d3d12.zig"
    click Metal "https://github.com/hexops/mach/blob/main/src/sysgpu/metal.zig"
    click Vulkan "https://github.com/hexops/mach/blob/main/src/sysgpu/vulkan.zig"
    click OpenGL "https://github.com/hexops/mach/blob/main/src/sysgpu/opengl.zig"
    click Parser "https://github.com/hexops/mach/blob/main/src/sysgpu/shader/Parser.zig"
    click GLSL "https://github.com/hexops/mach/blob/main/src/sysgpu/shader/codegen/glsl.zig"
    click HLSL "https://github.com/hexops/mach/blob/main/src/sysgpu/shader/codegen/hlsl.zig"
    click MSL "https://github.com/hexops/mach/blob/main/src/sysgpu/shader/codegen/msl.zig"
    click SPIRV "https://github.com/hexops/mach/blob/main/src/sysgpu/shader/codegen/spirv.zig"
    click SYSAUDIO "https://github.com/hexops/mach/blob/main/src/sysaudio/main.zig"
    click WASAPI "https://github.com/hexops/mach/blob/main/src/sysaudio/wasapi.zig"
    click CoreAudio "https://github.com/hexops/mach/blob/main/src/sysaudio/coreaudio.zig"
    click ALSA "https://github.com/hexops/mach/blob/main/src/sysaudio/alsa.zig"
    click PulseAudio "https://github.com/hexops/mach/blob/main/src/sysaudio/pulseaudio.zig"
    click PipeWire "https://github.com/hexops/mach/blob/main/src/sysaudio/pipewire.zig"
    click JACK "https://github.com/hexops/mach/blob/main/src/sysaudio/jack.zig"
    click Math "https://github.com/hexops/mach/blob/main/src/math/main.zig"
    click Vec "https://github.com/hexops/mach/blob/main/src/math/vec.zig"
    click Mat "https://github.com/hexops/mach/blob/main/src/math/mat.zig"
    click Quat "https://github.com/hexops/mach/blob/main/src/math/quat.zig"
    click Collision "https://github.com/hexops/mach/blob/main/src/math/collision.zig"
    click Time "https://github.com/hexops/mach/blob/main/src/time/main.zig"
    click Timer "https://github.com/hexops/mach/blob/main/src/time/Timer.zig"
    click Frequency "https://github.com/hexops/mach/blob/main/src/time/Frequency.zig"
    click Sprite "https://github.com/hexops/mach/blob/main/src/gfx/Sprite.zig"
    click Text "https://github.com/hexops/mach/blob/main/src/gfx/Text.zig"
    click Atlas "https://github.com/hexops/mach/blob/main/src/gfx/atlas/Atlas.zig"
```
