# LearnR

**Repository Path**: alienity/LearnR

## Basic Information

- **Project Name**: LearnR
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-01
- **Last Updated**: 2026-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Based on the code map provided, I can see this is a DirectX 12 rendering engine project. Let me create a comprehensive README.md file for this project.

# LearnR

一个基于 DirectX 12 的现代渲染引擎，支持光线追踪、全局光照和多种高级渲染技术。

## 特性

### 核心渲染技术
- **光线追踪 (Ray Tracing)** - 支持路径追踪、光线追踪阴影、环境光遮蔽和反射
- **DDGI (Dynamic Diffuse Global Illumination)** - 动态漫反射全局光照
- **ReSTIR** - Resampled Importance Sampling，用于高效的直接和间接光照采样
- **Nanite** - 虚拟化几何系统，支持海量三角形渲染
- **Meshlets** - GPU 驱动的网格渲染技术

### 后处理效果
- 泛光 (Bloom)
- 景深 (Depth of Field)
- 运动模糊 (Motion Blur)
- 屏幕空间反射 (SSR)
- 屏幕空间环境光遮蔽 (SSAO/HBAO)
- 色调映射 (Tonemapping)
- 胶片效果 (Film Effects)
- 抗锯齿 (FXAA, TAA)

### 环境效果
- 大气散射
- 体积云
- 海洋渲染 (FFT 波浪)
- 雨滴模拟
- 天空盒

## 项目结构

```
LearnR/
├── Assets/
│   ├── Fonts/          # 字体文件
│   ├── Models/          # 3D 模型 (Sponza, ToyCar 等)
│   ├── Scenes/         # 场景配置文件
│   ├── Shaders/        # HLSL 着色器
│   └── Textures/       # 纹理资源
├── External/           # 第三方依赖
│   ├── D3D12MA/        # DirectX 12 内存分配器
│   ├── DirectX12 Agility SDK/
│   ├── DLSS/           # NVIDIA DLSS
│   └── FidelityFX-SDK/ # AMD FidelityFX
├── Source/
│   ├── Core/           # 核心功能
│   ├── Editor/         # 编辑器
│   ├── Graphics/       # 图形抽象层
│   ├── RenderGraph/    # 渲染图系统
│   └── Rendering/      # 渲染实现
└── CMakeLists.txt      # 构建配置
```

## 构建要求

- **操作系统**: Windows 10/11 或 macOS
- **编译器**: MSVC (Windows) 或 Xcode (macOS)
- **SDK**: DirectX 12 Agility SDK
- **构建工具**: CMake 3.20+

## 构建指南

### Windows (MSVC)

```bash
# 创建构建目录
mkdir build && cd build

# 配置项目
cmake -G "Visual Studio 17 2022" -A x64 ..

# 构建
cmake --build . --config Release
```

### macOS (Xcode)

```bash
# 创建构建目录
mkdir build && cd build

# 配置项目
cmake -G Xcode ..

# 构建
cmake --build . --config Release
```

## 构建类型

| 类型 | 描述 |
|------|------|
| Debug | 调试版本，包含完整调试信息 |
| Profile | 发布版本 + 调试信息 + Tracy 性能分析 |
| Release | 优化版本 |
| RelWithDebInfo | 发布版本 + 调试信息 |

## 技术栈

- **图形 API**: DirectX 12
- **着色器语言**: HLSL
- **构建系统**: CMake
- **内存管理**: D3D12 Memory Allocator
- **AI 超采样**: NVIDIA DLSS
- **后处理**: AMD FidelityFX (CACAO, CAS, DOF)

## 许可证

本项目仅供学习研究使用。

## 贡献

欢迎提交 Issue 和 Pull Request。