# megayuchi/d3d12lecture architecture

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

## Overview

##### Project Type and Purpose
This is a DirectX 12 graphics engine implementation with progressive examples, moving from basic device creation to a full game engine framework. The project demonstrates various graphics programming concepts and best practices.

##### Main Components

a. Core Engine Layer:
- D3D12Renderer (Core rendering system)
- ResourceManager (GPU resource management)
- CommandListPool (Command list handling)
- DescriptorPool (Descriptor heap management)

b. Resource Management Layer:
- TextureManager
- ConstantBufferManager
- FontManager
- RenderQueue

c. Game Framework Layer:
- Game Engine Core
- GameObject System
- RenderThread (Multi-threaded rendering)
- Scene Management

**[Application Layer]**

- ▼
**[Game Framework Layer]**

- ▼
**[Resource Management Layer]**

- ▼
**[Core Engine Layer]**

- ▼
**[DirectX 12 / Hardware Layer]**

##### Key Relationships

- Resource management system's interaction with both the game framework and core engine
- Multi-threaded rendering pipeline
- Demonstrate the descriptor and resource management systems

##### Important Details

a. Memory Management:
- Both CPU and GPU memory pools
- Descriptor heap management
- Constant buffer organization

b. Rendering Pipeline:
- Command list creation and execution
- Resource state transitions
- Render queue organization

c. Threading Model:
- Main thread responsibilities
- Render thread workflow
- Synchronization points

##### Specific Implementation Notes

- Progression from basic triangle rendering to full engine framework
- Relationship between BasicMeshObject, SpriteObject, and the rendering system
- How the shader system integrates with the resource management
- Demonstrate the virtual interface system for renderer abstraction

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Application
        Game["Game Engine Core"]
        GameObj["GameObject System"]
    end

    subgraph Framework
        RThread["Render Thread"]
        VInterface["Virtual Interface System"]
        BMesh["Basic Mesh System"]
        Sprite["Sprite System"]
    end

    subgraph ResourceMgmt
        TManager["Texture Manager"]
        CBManager["Constant Buffer Manager"]
        FManager["Font Manager"]
        RQueue["Render Queue"]
    end

    subgraph CoreEngine
        D3DR["D3D12 Renderer"]
        ResMgr["Resource Manager"]
        CmdPool["Command List Pool"]
        DescPool["Descriptor Pool"]
        Shaders["Shader Management"]
    end

    subgraph Hardware
        DX12["DirectX 12"]
        GPU["GPU"]
    end

    %% Relationships
    Game --> GameObj
    GameObj --> RQueue
    GameObj --> BMesh
    GameObj --> Sprite
    
    RThread --> CmdPool
    RThread --> RQueue
    VInterface --> D3DR
    
    TManager --> ResMgr
    CBManager --> ResMgr
    FManager --> ResMgr
    RQueue --> CmdPool
    
    D3DR --> DX12
    ResMgr --> DescPool
    CmdPool --> GPU
    DescPool --> GPU
    Shaders --> D3DR

    %% Click events
    click Game "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/App/Game.h/cpp"
    click GameObj "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/App/GameObject.h/cpp"
    click RThread "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/RenderThread.h/cpp"
    click VInterface "https://github.com/megayuchi/D3D12Lecture/blob/main/22_GameEngineFramework/Common/IRenderer.h"
    click BMesh "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/BasicMeshObject.h/cpp"
    click Sprite "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/SpriteObject.h/cpp"
    click TManager "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/TextureManager.h/cpp"
    click CBManager "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/ConstantBufferManager.h/cpp"
    click FManager "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/FontManager.h/cpp"
    click RQueue "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/RenderQueue.h/cpp"
    click D3DR "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/D3D12Renderer.h/cpp"
    click ResMgr "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/D3D12ResourceManager.h/cpp"
    click CmdPool "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/CommandListPool.h/cpp"
    click DescPool "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/DescriptorPool.h/cpp"
    click Shaders "https://github.com/megayuchi/D3D12Lecture/tree/main/22_GameEngineFramework/RendererD3D12/Shaders/"

    %% Styling
    classDef application fill:#FFE5CC,stroke:#FF9933
    classDef framework fill:#E5FFCC,stroke:#99FF33
    classDef resource fill:#CCE5FF,stroke:#3399FF
    classDef core fill:#FFCCCC,stroke:#FF3333
    classDef hardware fill:#E5CCFF,stroke:#9933FF

    class Game,GameObj application
    class RThread,VInterface,BMesh,Sprite framework
    class TManager,CBManager,FManager,RQueue resource
    class D3DR,ResMgr,CmdPool,DescPool,Shaders core
    class DX12,GPU hardware
```
