# emoon/minifb architecture

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

- Interactive diagram: https://gitdiagram.com/emoon/minifb
- Repository: https://github.com/emoon/minifb

## Overview

##### Main Components and Architecture

The system should be represented as a layered architecture with the following main components:

a) API Layer (Top Level):
- Public headers (MiniFB.h, MiniFB_cpp.h, MiniFB_enums.h)
- C and C++ interfaces

b) Platform-Specific Implementations (Middle Layer):
Divide into separate modules for each supported platform:
- Windows (WinMiniFB)
- MacOS X (MacMiniFB)
- X11 (X11MiniFB)
- Wayland (WaylandMiniFB)
- iOS (iOSMiniFB)
- Android (AndroidMiniFB)
- Web/WASM (WebMiniFB)

c) Common Core (Bottom Layer):
- Common functionality (MiniFB_common.c)
- Internal implementations (MiniFB_internal.c)
- Timer functionality (MiniFB_timer.c)
- OpenGL backend (MiniFB_GL.c)

##### Component Relationships

a) Data Flow:
- How pixel buffer data flows from user application through the API
- How platform-specific implementations handle the buffer
- Event handling flow (keyboard, mouse, window events)

b) Dependencies:
- Platform-specific modules to their respective window systems
- OpenGL backend integration where applicable
- Timer system connections

##### Specific Elements

a) Core Features:
- Window management
- Buffer rendering
- Event handling
- Timer system
- Viewport management

b) Platform-Specific Features:
- Metal API support for MacOS
- OpenGL backend for Windows/X11
- Native UI components for mobile

##### Additional Details

Annotations for:
- Supported pixel formats (32-bit)
- API version compatibility notes
- Platform-specific limitations
- Build system requirements

##### Buffer management flow

This design will help developers understand both the high-level architecture and the specific implementation details of MiniFB while maintaining clarity about platform-specific variations.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph API
        MiniFB[MiniFB.h]
        MiniFBCpp[MiniFB_cpp.h]
        MiniFBEnums[MiniFB_enums.h]
    end

    subgraph PlatformSpecific
        direction TB
        Win[Windows Implementation]
        Mac[MacOS Implementation]
        X11[X11 Implementation]
        Way[Wayland Implementation]
        iOS[iOS Implementation]
        And[Android Implementation]
        Web[Web/WASM Implementation]
    end

    subgraph CoreComponents
        Common[Common Functionality]
        Internal[Internal Implementation]
        Timer[Timer System]
        GL[OpenGL Backend]
    end

    subgraph DataStructures
        WinData[Windows Data]
        MacData[MacOS Data]
        X11Data[X11 Data]
        WayData[Wayland Data]
        iOSData[iOS Data]
        AndroidData[Android Data]
        BaseData[Base Window Data]
    end

    subgraph PlatformUI
        iOSView[iOS View]
        iOSController[iOS Controller]
        MacView[MacOS View]
        MacWindow[MacOS Window]
    end

    %% API Layer Connections
    MiniFB --> Win
    MiniFB --> Mac
    MiniFB --> X11
    MiniFB --> Way
    MiniFB --> iOS
    MiniFB --> And
    MiniFB --> Web

    %% Platform to Core Connections
    Win --> Common
    Mac --> Common
    X11 --> Common
    Way --> Common
    iOS --> Common
    And --> Common
    Web --> Common

    %% Core Interconnections
    Common --> Internal
    Common --> Timer
    Common --> GL

    %% Data Structure Connections
    BaseData --> WinData
    BaseData --> MacData
    BaseData --> X11Data
    BaseData --> WayData
    BaseData --> iOSData
    BaseData --> AndroidData

    %% Platform UI Connections
    iOS --> iOSView
    iOS --> iOSController
    Mac --> MacView
    Mac --> MacWindow

    %% Click Events
    click MiniFB "https://github.com/emoon/minifb/blob/master/include/MiniFB.h"
    click MiniFBCpp "https://github.com/emoon/minifb/blob/master/include/MiniFB_cpp.h"
    click MiniFBEnums "https://github.com/emoon/minifb/blob/master/include/MiniFB_enums.h"
    click Win "https://github.com/emoon/minifb/blob/master/src/windows/WinMiniFB.c"
    click Mac "https://github.com/emoon/minifb/blob/master/src/macosx/MacMiniFB.m"
    click X11 "https://github.com/emoon/minifb/blob/master/src/x11/X11MiniFB.c"
    click Way "https://github.com/emoon/minifb/blob/master/src/wayland/WaylandMiniFB.c"
    click iOS "https://github.com/emoon/minifb/blob/master/src/ios/iOSMiniFB.m"
    click And "https://github.com/emoon/minifb/blob/master/src/android/AndroidMiniFB.c"
    click Web "https://github.com/emoon/minifb/blob/master/src/web/WebMiniFB.c"
    click Common "https://github.com/emoon/minifb/blob/master/src/MiniFB_common.c"
    click Internal "https://github.com/emoon/minifb/blob/master/src/MiniFB_internal.c"
    click Timer "https://github.com/emoon/minifb/blob/master/src/MiniFB_timer.c"
    click GL "https://github.com/emoon/minifb/blob/master/src/gl/MiniFB_GL.c"
    click BaseData "https://github.com/emoon/minifb/blob/master/src/WindowData.h"
    click WinData "https://github.com/emoon/minifb/blob/master/src/windows/WindowData_Win.h"
    click MacData "https://github.com/emoon/minifb/blob/master/src/macosx/WindowData_OSX.h"
    click X11Data "https://github.com/emoon/minifb/blob/master/src/x11/WindowData_X11.h"
    click WayData "https://github.com/emoon/minifb/blob/master/src/wayland/WindowData_Way.h"
    click iOSData "https://github.com/emoon/minifb/blob/master/src/ios/WindowData_IOS.h"
    click AndroidData "https://github.com/emoon/minifb/blob/master/src/android/WindowData_Android.h"
    click iOSView "https://github.com/emoon/minifb/blob/master/src/ios/iOSView.h"
    click iOSController "https://github.com/emoon/minifb/blob/master/src/ios/iOSViewController.h"
    click MacView "https://github.com/emoon/minifb/blob/master/src/macosx/OSXView.h"
    click MacWindow "https://github.com/emoon/minifb/blob/master/src/macosx/OSXWindow.h"

    classDef api fill:#a8d1f0
    classDef platform fill:#90EE90
    classDef core fill:#FFE5B4
    classDef data fill:#FFB6C1
    classDef ui fill:#DDA0DD

    class MiniFB,MiniFBCpp,MiniFBEnums api
    class Win,Mac,X11,Way,iOS,And,Web platform
    class Common,Internal,Timer,GL core
    class BaseData,WinData,MacData,X11Data,WayData,iOSData,AndroidData data
    class iOSView,iOSController,MacView,MacWindow ui
```
