docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,29 @@
# D3D12Texture::GetArraySize
## 函数签名
```cpp
uint32_t GetArraySize() const
```
## 中文描述
获取纹理数组大小。对于非数组纹理,返回 1。
## 返回值
`uint32_t` - 数组大小
## 复杂度
O(1)
## 示例
```cpp
uint32_t arraySize = texture->GetArraySize();
```
## 相关文档
- [D3D12Texture](texture.md) - 类总览

View File

@@ -0,0 +1,38 @@
# D3D12Texture::InitializeDepthStencil
## 函数签名
```cpp
bool InitializeDepthStencil(ID3D12Device* device, uint32_t width, uint32_t height, DXGI_FORMAT format = DXGI_FORMAT_D24_UNORM_S8_UINT)
```
## 中文描述
初始化深度模板纹理。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `width` | `uint32_t` | 纹理宽度 |
| `height` | `uint32_t` | 纹理高度 |
| `format` | `DXGI_FORMAT` | 深度格式(默认 D24_UNORM_S8_UINT |
## 返回值
`bool` - 初始化是否成功
## 复杂度
O(n) - 取决于纹理大小
## 示例
```cpp
texture->InitializeDepthStencil(device, 1920, 1080);
```
## 相关文档
- [D3D12Texture](texture.md) - 类总览

View File

@@ -0,0 +1,42 @@
# D3D12Texture::InitializeFromData
## 函数签名
```cpp
bool InitializeFromData(ID3D12Device* device, ID3D12GraphicsCommandList* commandList,
const void* pixelData, uint32_t width, uint32_t height, DXGI_FORMAT format)
```
## 中文描述
从像素数据初始化纹理,内部会创建上传堆并复制数据。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `commandList` | `ID3D12GraphicsCommandList*` | 命令列表指针 |
| `pixelData` | `const void*` | 像素数据指针 |
| `width` | `uint32_t` | 纹理宽度 |
| `height` | `uint32_t` | 纹理高度 |
| `format` | `DXGI_FORMAT` | 像素格式 |
## 返回值
`bool` - 初始化是否成功
## 复杂度
O(n) - 取决于纹理大小,内部创建临时上传堆
## 示例
```cpp
std::vector<uint8_t> pixels = LoadImage("texture.png");
texture->InitializeFromData(device, cmdList, pixels.data(), width, height, DXGI_FORMAT_R8G8B8A8_UNORM);
```
## 相关文档
- [D3D12Texture](texture.md) - 类总览

View File

@@ -0,0 +1,34 @@
# D3D12Texture
**命名空间**: `XCEngine::RHI`
**描述**: DirectX 12 纹理的 D3D12 实现,继承自 `RHITexture`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `InitializeFromExisting` | [详细文档](../buffer/initialize-from-existing.md) |
| `InitializeFromData` | [详细文档](initialize-from-data.md) |
| `InitializeDepthStencil` | [详细文档](initialize-depth-stencil.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetResource` | [详细文档](../buffer/get-resource.md) |
| `GetDesc` | [详细文档](../buffer/get-desc.md) |
| `GetWidth` | [详细文档](../../texture/get-width.md) |
| `GetHeight` | [详细文档](../../texture/get-height.md) |
| `GetDepth` | [详细文档](../../texture/get-depth.md) |
| `GetMipLevels` | [详细文档](../../texture/get-mip-levels.md) |
| `GetArraySize` | [详细文档](get-array-size.md) |
| `GetGPUAddress` | [详细文档](../buffer/get-gpu-address.md) |
| `GetSize` | [详细文档](../../buffer/get-size.md) |
| `GetName` / `SetName` | [详细文档](../../buffer/get-name.md) |
| `GetFormat` | [详细文档](../../texture/get-format.md) |
| `GetTextureType` | [详细文档](../../texture/get-texture-type.md) |
| `GetState` / `SetState` | [详细文档](../../buffer/get-state.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [RHITexture](../../texture/texture.md) - 抽象纹理接口