From 5257f3d75c833048d887883a753ab5d81d42e410 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Thu, 19 Mar 2026 02:01:18 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20Fix=20SKILL.md=E8=A7=84=E8=8C=83=20viol?= =?UTF-8?q?ations=20-=20Remove=20##=20=E6=96=B9=E6=B3=95=E5=88=97=E8=A1=A8?= =?UTF-8?q?=20and=20flatten=20###=20sub-headers=20in=20##=20=E5=85=AC?= =?UTF-8?q?=E5=85=B1=E6=96=B9=E6=B3=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/containers/array/array.md | 29 +-- docs/api/containers/hashmap/hashmap.md | 34 +--- docs/api/containers/string/string.md | 29 +-- docs/api/core/event/event.md | 38 +--- docs/api/core/filewriter/filewriter.md | 33 +--- docs/api/core/refcounted/refcounted.md | 21 +- docs/api/core/smartptr/smartptr.md | 10 +- docs/api/core/types/types.md | 20 +- docs/api/main.md | 2 +- .../linear-allocator/linear-allocator.md | 17 -- .../memory/pool-allocator/pool-allocator.md | 12 -- .../memory/proxy-allocator/proxy-allocator.md | 12 -- docs/api/rhi/buffer/buffer.md | 52 ++--- docs/api/rhi/command-list/command-list.md | 99 +++------- docs/api/rhi/command-queue/command-queue.md | 37 +--- docs/api/rhi/d3d12/README.md | 36 ---- docs/api/rhi/d3d12/buffer/buffer.md | 46 +++-- .../command-allocator/command-allocator.md | 16 +- .../rhi/d3d12/command-list/command-list.md | 183 +++++------------- .../rhi/d3d12/command-queue/command-queue.md | 28 +-- docs/api/rhi/d3d12/common/common.md | 2 +- .../constant-buffer-view.md | 12 +- docs/api/rhi/d3d12/{overview.md => d3d12.md} | 0 .../depth-stencil-view/depth-stencil-view.md | 16 +- .../d3d12/descriptor-heap/descriptor-heap.md | 31 ++- docs/api/rhi/d3d12/device/device.md | 51 +++-- docs/api/rhi/d3d12/enums/enums.md | 2 +- docs/api/rhi/d3d12/fence/fence.md | 24 +-- .../d3d12/pipeline-state/pipeline-state.md | 24 +-- docs/api/rhi/d3d12/query-heap/query-heap.md | 18 +- .../render-target-view/render-target-view.md | 16 +- .../d3d12/root-signature/root-signature.md | 34 ++-- docs/api/rhi/d3d12/sampler/sampler.md | 19 +- docs/api/rhi/d3d12/screenshot/screenshot.md | 10 +- .../shader-resource-view.md | 16 +- docs/api/rhi/d3d12/shader/shader.md | 31 +-- docs/api/rhi/d3d12/swap-chain/swap-chain.md | 35 ++-- docs/api/rhi/d3d12/texture/texture.md | 44 +++-- docs/api/rhi/d3d12/types/types.md | 2 +- .../unordered-access-view.md | 8 +- .../rhi/descriptor-pool/descriptor-pool.md | 19 +- docs/api/rhi/device/device.md | 42 ++-- docs/api/rhi/factory/factory.md | 6 +- docs/api/rhi/fence/fence.md | 26 +-- docs/api/rhi/opengl/README.md | 2 +- docs/api/rhi/opengl/buffer/buffer.md | 46 +++-- .../rhi/opengl/command-list/command-list.md | 63 +++--- .../rhi/opengl/command-queue/command-queue.md | 22 +-- .../depth-stencil-view/depth-stencil-view.md | 33 ++-- docs/api/rhi/opengl/device/device.md | 48 ++--- docs/api/rhi/opengl/fence/fence.md | 24 +-- .../opengl/pipeline-state/pipeline-state.md | 52 ++--- .../render-target-view/render-target-view.md | 29 +-- docs/api/rhi/opengl/sampler/sampler.md | 16 +- docs/api/rhi/opengl/shader/shader.md | 40 ++-- docs/api/rhi/opengl/swap-chain/swap-chain.md | 44 +++-- docs/api/rhi/opengl/texture/texture.md | 52 ++--- .../rhi/opengl/vertex-array/vertex-array.md | 22 +-- .../rhi/pipeline-layout/pipeline-layout.md | 15 +- docs/api/rhi/pipeline-state/pipeline-state.md | 24 +-- docs/api/rhi/rhi.md | 2 +- docs/api/rhi/sampler/sampler.md | 24 +-- docs/api/rhi/shader/shader.md | 55 ++---- docs/api/rhi/swap-chain/swap-chain.md | 46 ++--- docs/api/rhi/texture/texture.md | 43 ++-- docs/api/threading/task-system/task-system.md | 32 --- docs/api/threading/task/task.md | 14 +- docs/api/threading/thread/thread.md | 17 -- 68 files changed, 718 insertions(+), 1289 deletions(-) delete mode 100644 docs/api/rhi/d3d12/README.md rename docs/api/rhi/d3d12/{overview.md => d3d12.md} (100%) diff --git a/docs/api/containers/array/array.md b/docs/api/containers/array/array.md index 8da6f8fb..d743c308 100644 --- a/docs/api/containers/array/array.md +++ b/docs/api/containers/array/array.md @@ -19,50 +19,23 @@ ## 公共方法 -### 构造/析构 - | 方法 | 描述 | |------|------| | [Constructor](constructor.md) | 构造数组实例 | | [Copy/Move Constructor](copy-move-constructor.md) | 拷贝或移动构造 | | [Destructor](destructor.md) | 析构函数 | | [operator=](operator-assign.md) | 赋值运算符 | - -### 元素访问 - -| 方法 | 描述 | -|------|------| -| [operator[]](./operator-subscript.md) | 下标访问 | +| [operator[]](operator-subscript.md) | 下标访问 | | [Data](data.md) | 获取原始数据指针 | | [Front/Back](front-back.md) | 获取首/尾元素引用 | - -### 容量管理 - -| 方法 | 描述 | -|------|------| | [Size/Capacity/Empty](size.md) | 获取尺寸信息 | | [Clear](clear.md) | 清空所有元素 | | [Reserve](reserve.md) | 预留容量 | | [Resize](resize.md) | 调整大小 | - -### 元素操作 - -| 方法 | 描述 | -|------|------| | [PushBack](pushback.md) | 尾部添加（拷贝/移动） | | [EmplaceBack](emplaceback.md) | 就地构造尾部添加 | | [PopBack](popback.md) | 尾部移除 | - -### 迭代器 - -| 方法 | 描述 | -|------|------| | [begin/end](iterator.md) | 获取迭代器 | - -### 内存分配器 - -| 方法 | 描述 | -|------|------| | [SetAllocator](setallocator.md) | 设置内存分配器 | ## 使用示例 diff --git a/docs/api/containers/hashmap/hashmap.md b/docs/api/containers/hashmap/hashmap.md index 36a44ef0..96b5998e 100644 --- a/docs/api/containers/hashmap/hashmap.md +++ b/docs/api/containers/hashmap/hashmap.md @@ -28,52 +28,20 @@ ## 公共方法 -### 构造/析构 - | 方法 | 描述 | |------|------| | [Constructor](constructor.md) | 构造哈希表实例 | | [Destructor](destructor.md) | 析构函数 | | [operator=](operator-assign.md) | 赋值运算符 | | [Copy/Move](copy-move.md) | 拷贝/移动构造 | - -### 元素访问 - -| 方法 | 描述 | -|------|------| -| [operator[]](./operator-subscript.md) | 下标访问（不存在时插入） | - -### 查找 - -| 方法 | 描述 | -|------|------| +| [operator[]](operator-subscript.md) | 下标访问（不存在时插入） | | [Find](find.md) | 查找键对应的值指针 | | [Contains](contains.md) | 检查是否包含键 | - -### 插入/删除 - -| 方法 | 描述 | -|------|------| | [Insert](insert.md) | 插入键值对 | | [Erase](erase.md) | 删除键对应的元素 | | [Clear](clear.md) | 清空所有元素 | - -### 容量 - -| 方法 | 描述 | -|------|------| | [Size/Empty](size.md) | 获取元素数量 | - -### 迭代器 - -| 方法 | 描述 | -|------|------| | [begin/end](iterator.md) | 获取迭代器 | - -### 内存分配器 - -| 方法 | 描述 | -|------|------| | [SetAllocator](setallocator.md) | 设置内存分配器 | ## 使用示例 diff --git a/docs/api/containers/string/string.md b/docs/api/containers/string/string.md index b95e0130..0f425be6 100644 --- a/docs/api/containers/string/string.md +++ b/docs/api/containers/string/string.md @@ -24,51 +24,24 @@ ## 公共方法 -### 构造/析构 - | 方法 | 描述 | |------|------| | [Constructor](constructor.md) | 构造字符串实例 | | [Destructor](destructor.md) | 析构函数 | | [operator=](operator-assign.md) | 赋值运算符 | - -### 连接运算符 - -| 方法 | 描述 | -|------|------| | [operator+=](operator-plus-assign.md) | 追加字符串/字符 | | [operator+](../string/operator-plus.md) | 字符串连接 | - -### 比较运算符 - -| 方法 | 描述 | -|------|------| | [operator==](../string/operator-equal.md) | 判断两个字符串是否相等 | | [operator!=](../string/operator-equal.md) | 判断两个字符串是否不相等 | - -### 字符串操作 - -| 方法 | 描述 | -|------|------| | [Substring](substring.md) | 获取子串 | | [Trim](trim.md) | 去除首尾空白 | | [ToLower/ToUpper](to-lower-upper.md) | 大小写转换 | | [Find](find.md) | 查找子串位置 | | [StartsWith](starts-with.md) | 检查前缀 | | [EndsWith](ends-with.md) | 检查后缀 | - -### 元素访问 - -| 方法 | 描述 | -|------|------| | [CStr](cstr.md) | 获取 C 字符串指针 | | [Length/Capacity/Empty](size.md) | 获取尺寸信息 | -| [operator[]](./operator-subscript.md) | 下标访问 | - -### 容量管理 - -| 方法 | 描述 | -|------|------| +| [operator[]](operator-subscript.md) | 下标访问 | | [Clear](clear.md) | 清空字符串 | | [Reserve/Resize](reserve-resize.md) | 预留/调整容量 | diff --git a/docs/api/core/event/event.md b/docs/api/core/event/event.md index decd36c1..ce4575cc 100644 --- a/docs/api/core/event/event.md +++ b/docs/api/core/event/event.md @@ -26,39 +26,15 @@ ## 公共方法 -### 订阅/退订 - | 方法 | 描述 | |------|------| -| `uint64_t Subscribe(Callback callback)` | 订阅事件，返回订阅 ID | -| `void Unsubscribe(uint64_t id)` | 退订事件（延迟生效） | -| `void ProcessUnsubscribes()` | 处理积压的退订请求 | -| `void Clear()` | 清空所有订阅 | - -### 调用 - -| 方法 | 描述 | -|------|------| -| `void Invoke(Args... args)` | 调用所有订阅的回调 | - -### 迭代 - -| 方法 | 描述 | -|------|------| -| `Iterator begin()` | 获取开始迭代器 | -| `Iterator end()` | 获取结束迭代器 | - -## 方法列表 - -| 方法 | 描述 | -|------|------| -| [Subscribe](Subscribe.md) | 订阅事件回调 | -| [Unsubscribe](Unsubscribe.md) | 退订事件 | -| [ProcessUnsubscribes](ProcessUnsubscribes.md) | 处理积压的退订请求 | -| [Invoke](Invoke.md) | 调用所有订阅的回调 | -| [Clear](Clear.md) | 清空所有订阅 | -| [begin](begin.md) | 获取开始迭代器 | -| [end](end.md) | 获取结束迭代器 | +| [`Subscribe`](Subscribe.md) | 订阅事件回调，返回订阅 ID | +| [`Unsubscribe`](Unsubscribe.md) | 退订事件（延迟生效） | +| [`ProcessUnsubscribes`](ProcessUnsubscribes.md) | 处理积压的退订请求 | +| [`Clear`](Clear.md) | 清空所有订阅 | +| [`Invoke`](Invoke.md) | 调用所有订阅的回调 | +| [`begin`](begin.md) | 获取开始迭代器 | +| [`end`](end.md) | 获取结束迭代器 | ## 使用示例 diff --git a/docs/api/core/filewriter/filewriter.md b/docs/api/core/filewriter/filewriter.md index 23f57cd5..b1fe6b51 100644 --- a/docs/api/core/filewriter/filewriter.md +++ b/docs/api/core/filewriter/filewriter.md @@ -12,39 +12,16 @@ ## 公共方法 -### 构造/析构 - | 方法 | 描述 | |------|------| | `FileWriter()` | 默认构造（不打开文件） | | `FileWriter(const char* filePath, bool append = false)` | 构造并打开文件 | | `~FileWriter()` | 析构函数，自动关闭文件 | - -### 文件操作 - -| 方法 | 描述 | -|------|------| -| `bool Open(const char* filePath, bool append = false)` | 打开文件，append=true 时为追加模式 | -| `void Close()` | 关闭文件 | -| `bool IsOpen() const` | 检查文件是否已打开 | - -### 数据写入 - -| 方法 | 描述 | -|------|------| -| `bool Write(const char* data, size_t length)` | 写入指定长度的字符串 | -| `bool Write(const Containers::String& str)` | 写入 String 内容 | -| `bool Flush()` | 刷新缓冲区，确保数据写入磁盘 | - -## 方法列表 - -| 方法 | 描述 | -|------|------| -| [Open](Open.md) | 打开文件 | -| [Close](Close.md) | 关闭文件 | -| [IsOpen](IsOpen.md) | 检查文件是否已打开 | -| [Write](Write.md) | 写入数据 | -| [Flush](Flush.md) | 刷新缓冲区 | +| [`Open`](Open.md) | 打开文件，append=true 时为追加模式 | +| [`Close`](Close.md) | 关闭文件 | +| [`IsOpen`](IsOpen.md) | 检查文件是否已打开 | +| [`Write`](Write.md) | 写入数据 | +| [`Flush`](Flush.md) | 刷新缓冲区 | ## 使用示例 diff --git a/docs/api/core/refcounted/refcounted.md b/docs/api/core/refcounted/refcounted.md index 15800225..947bf283 100644 --- a/docs/api/core/refcounted/refcounted.md +++ b/docs/api/core/refcounted/refcounted.md @@ -12,28 +12,13 @@ ## 公共方法 -### 构造/析构 - | 方法 | 描述 | |------|------| | `RefCounted()` | 构造函数，初始引用计数为 1 | | `virtual ~RefCounted()` | 虚析构函数 | - -### 引用计数 - -| 方法 | 描述 | -|------|------| -| `void AddRef()` | 增加引用计数 | -| `void Release()` | 减少引用计数（归零时自动 delete this） | -| `uint32_t GetRefCount() const` | 获取当前引用计数 | - -## 方法列表 - -| 方法 | 描述 | -|------|------| -| [AddRef](AddRef.md) | 增加引用计数 | -| [Release](Release.md) | 减少引用计数 | -| [GetRefCount](GetRefCount.md) | 获取当前引用计数 | +| [`AddRef`](AddRef.md) | 增加引用计数 | +| [`Release`](Release.md) | 减少引用计数（归零时自动 delete this） | +| [`GetRefCount`](GetRefCount.md) | 获取当前引用计数 | ## 使用示例 diff --git a/docs/api/core/smartptr/smartptr.md b/docs/api/core/smartptr/smartptr.md index 5467b082..f87ee2d0 100644 --- a/docs/api/core/smartptr/smartptr.md +++ b/docs/api/core/smartptr/smartptr.md @@ -24,14 +24,14 @@ | `Core::MakeRef(Args&&... args)` | `Ref` | 创建共享指针 | | `Core::MakeUnique(Args&&... args)` | `UniqueRef` | 创建独占指针 | -## 方法列表 +## 公共方法 | 方法 | 描述 | |------|------| -| [Ref](Ref.md) | `std::shared_ptr` 类型别名 | -| [UniqueRef](UniqueRef.md) | `std::unique_ptr` 类型别名 | -| [MakeRef](MakeRef.md) | 创建共享指针的工厂函数 | -| [MakeUnique](MakeUnique.md) | 创建独占指针的工厂函数 | +| [`Ref`](Ref.md) | `std::shared_ptr` 类型别名 | +| [`UniqueRef`](UniqueRef.md) | `std::unique_ptr` 类型别名 | +| [`MakeRef`](MakeRef.md) | 创建共享指针的工厂函数 | +| [`MakeUnique`](MakeUnique.md) | 创建独占指针的工厂函数 | ## 使用示例 diff --git a/docs/api/core/types/types.md b/docs/api/core/types/types.md index 1b621c3f..645077f8 100644 --- a/docs/api/core/types/types.md +++ b/docs/api/core/types/types.md @@ -26,19 +26,19 @@ | `uint64` | `uint64_t` | 64位无符号整数 | | `byte` | `uint8_t` | 字节类型 | -## 方法列表 +## 公共方法 | 方法 | 描述 | |------|------| -| [int8](int8.md) | 8位有符号整数类型别名 | -| [int16](int16.md) | 16位有符号整数类型别名 | -| [int32](int32.md) | 32位有符号整数类型别名 | -| [int64](int64.md) | 64位有符号整数类型别名 | -| [uint8](uint8.md) | 8位无符号整数类型别名 | -| [uint16](uint16.md) | 16位无符号整数类型别名 | -| [uint32](uint32.md) | 32位无符号整数类型别名 | -| [uint64](uint64.md) | 64位无符号整数类型别名 | -| [byte](byte.md) | 字节类型别名 | +| [`int8`](int8.md) | 8位有符号整数类型别名 | +| [`int16`](int16.md) | 16位有符号整数类型别名 | +| [`int32`](int32.md) | 32位有符号整数类型别名 | +| [`int64`](int64.md) | 64位有符号整数类型别名 | +| [`uint8`](uint8.md) | 8位无符号整数类型别名 | +| [`uint16`](uint16.md) | 16位无符号整数类型别名 | +| [`uint32`](uint32.md) | 32位无符号整数类型别名 | +| [`uint64`](uint64.md) | 64位无符号整数类型别名 | +| [`byte`](byte.md) | 字节类型别名 | ## 使用示例 diff --git a/docs/api/main.md b/docs/api/main.md index 6d5f9650..1f9f256a 100644 --- a/docs/api/main.md +++ b/docs/api/main.md @@ -9,7 +9,7 @@ | 模块 | 文档目录 | 描述 | |------|----------|------| | **RHI** | [rhi/](rhi/rhi.md) | 渲染硬件接口抽象层 | -| **D3D12** | [rhi/d3d12/](rhi/d3d12/overview.md) | DirectX 12 后端实现 | +| **D3D12** | [rhi/d3d12/](rhi/opengl/overview.md) | DirectX 12 后端实现 | | **OpenGL** | [rhi/opengl/](rhi/opengl/overview.md) | OpenGL 后端实现 | | **Containers** | [containers/](containers/containers.md) | 容器数据结构 | | **Memory** | [memory/](memory/memory.md) | 内存管理 | diff --git a/docs/api/memory/linear-allocator/linear-allocator.md b/docs/api/memory/linear-allocator/linear-allocator.md index 5b93b6cc..5da70dd3 100644 --- a/docs/api/memory/linear-allocator/linear-allocator.md +++ b/docs/api/memory/linear-allocator/linear-allocator.md @@ -12,33 +12,16 @@ ## 公共方法 -### 生命周期 - | 方法 | 描述 | |------|------| | `LinearAllocator` | 构造线性分配器 | | `~LinearAllocator` | 析构函数，释放底层缓冲区 | - -### 内存操作 - -| 方法 | 描述 | -|------|------| | `Allocate` | 顺序分配内存 | | `Free` | 无效果（不支持） | | `Reallocate` | 不支持（始终返回 nullptr） | | `Clear` | 清空所有分配 | - -### 标记和回滚 - -| 方法 | 描述 | -|------|------| | `GetMarker` | 获取当前位置标记 | | `SetMarker` | 回滚到指定标记位置 | - -### 查询方法 - -| 方法 | 描述 | -|------|------| | `GetUsedSize` | 获取已使用字节数 | | `GetCapacity` | 获取总容量 | diff --git a/docs/api/memory/pool-allocator/pool-allocator.md b/docs/api/memory/pool-allocator/pool-allocator.md index 31da1ddf..565fffef 100644 --- a/docs/api/memory/pool-allocator/pool-allocator.md +++ b/docs/api/memory/pool-allocator/pool-allocator.md @@ -12,25 +12,13 @@ ## 公共方法 -### 生命周期 - | 方法 | 描述 | |------|------| | `PoolAllocator` | 构造内存池分配器 | | `~PoolAllocator` | 析构函数，释放整个内存池 | - -### 内存操作 - -| 方法 | 描述 | -|------|------| | `Allocate` | 分配一个内存块 | | `Free` | 释放内存块回空闲链表 | | `Reallocate` | 不支持（始终返回 nullptr） | - -### 查询方法 - -| 方法 | 描述 | -|------|------| | `Contains` | 检查指针是否属于此池 | | `GetBlockSize` | 获取块大小 | | `GetFreeBlockCount` | 获取空闲块数量 | diff --git a/docs/api/memory/proxy-allocator/proxy-allocator.md b/docs/api/memory/proxy-allocator/proxy-allocator.md index 12e3212b..40f67364 100644 --- a/docs/api/memory/proxy-allocator/proxy-allocator.md +++ b/docs/api/memory/proxy-allocator/proxy-allocator.md @@ -12,25 +12,13 @@ ## 公共方法 -### 生命周期 - | 方法 | 描述 | |------|------| | `ProxyAllocator` | 构造代理分配器 | | `~ProxyAllocator` | 析构函数 | - -### 内存操作 - -| 方法 | 描述 | -|------|------| | `Allocate` | 分配内存并记录统计 | | `Free` | 释放内存并记录统计 | | `Reallocate` | 转发到底层分配器 | - -### 统计查询 - -| 方法 | 描述 | -|------|------| | `GetStats` | 获取详细统计信息 | ## 构造函数 diff --git a/docs/api/rhi/buffer/buffer.md b/docs/api/rhi/buffer/buffer.md index f9148e7d..1e774eff 100644 --- a/docs/api/rhi/buffer/buffer.md +++ b/docs/api/rhi/buffer/buffer.md @@ -12,44 +12,22 @@ ## 公共方法 -### 数据操作 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Map` | [详细文档](map.md) | -| `Unmap` | [详细文档](unmap.md) | -| `SetData` | [详细文档](set-data.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetSize` | [详细文档](get-size.md) | -| `GetBufferType` | [详细文档](get-buffer-type.md) | -| `SetBufferType` | [详细文档](set-buffer-type.md) | -| `GetStride` | [详细文档](get-stride.md) | -| `SetStride` | [详细文档](set-stride.md) | - -### 状态管理 - -| 方法 | 文档 | -|------|------| -| `GetState` | [详细文档](get-state.md) | -| `SetState` | [详细文档](set-state.md) | - -### 生命周期 - -| 方法 | 文档 | -|------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | -| `GetName` | [详细文档](get-name.md) | -| `SetName` | [详细文档](set-name.md) | +| [`Map`](map.md) | 映射缓冲区到 CPU 可访问内存 | +| [`Unmap`](unmap.md) | 取消映射 | +| [`SetData`](set-data.md) | 设置缓冲区数据 | +| [`GetSize`](get-size.md) | 获取缓冲区大小 | +| [`GetBufferType`](get-buffer-type.md) | 获取缓冲区类型 | +| [`SetBufferType`](set-buffer-type.md) | 设置缓冲区类型 | +| [`GetStride`](get-stride.md) | 获取缓冲区步长 | +| [`SetStride`](set-stride.md) | 设置缓冲区步长 | +| [`GetState`](get-state.md) | 获取资源状态 | +| [`SetState`](set-state.md) | 设置资源状态 | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | +| [`GetName`](get-name.md) | 获取资源名称 | +| [`SetName`](set-name.md) | 设置资源名称 | ## 缓冲区类型 (BufferType) diff --git a/docs/api/rhi/command-list/command-list.md b/docs/api/rhi/command-list/command-list.md index d7df00f2..8196d893 100644 --- a/docs/api/rhi/command-list/command-list.md +++ b/docs/api/rhi/command-list/command-list.md @@ -8,80 +8,33 @@ ## 公共方法 -### 命令录制控制 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Reset` | [详细文档](reset.md) | -| `Close` | [详细文档](close.md) | - -### 资源状态转换 - -| 方法 | 文档 | -|------|------| -| `TransitionBarrier` | [详细文档](transition-barrier.md) | - -### 渲染状态设置 - -| 方法 | 文档 | -|------|------| -| `SetPipelineState` | [详细文档](set-pipeline-state.md) | -| `SetPrimitiveTopology` | [详细文档](set-primitive-topology.md) | -| `SetViewport` | [详细文档](set-viewport.md) | -| `SetViewports` | [详细文档](set-viewports.md) | -| `SetScissorRect` | [详细文档](set-scissor-rect.md) | -| `SetScissorRects` | [详细文档](set-scissor-rects.md) | -| `SetRenderTargets` | [详细文档](set-render-targets.md) | - -### 深度/混合状态 - -| 方法 | 文档 | -|------|------| -| `SetDepthStencilState` | [详细文档](set-depth-stencil-state.md) | -| `SetStencilRef` | [详细文档](set-stencil-ref.md) | -| `SetBlendState` | [详细文档](set-blend-state.md) | -| `SetBlendFactor` | [详细文档](set-blend-factor.md) | - -### 顶点/索引缓冲 - -| 方法 | 文档 | -|------|------| -| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) | -| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) | -| `SetIndexBuffer` | [详细文档](set-index-buffer.md) | - -### 绘制命令 - -| 方法 | 文档 | -|------|------| -| `Draw` | [详细文档](draw.md) | -| `DrawIndexed` | [详细文档](draw-indexed.md) | - -### 清除命令 - -| 方法 | 文档 | -|------|------| -| `Clear` | [详细文档](clear.md) | -| `ClearRenderTarget` | [详细文档](clear-render-target.md) | -| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) | - -### 资源复制 - -| 方法 | 文档 | -|------|------| -| `CopyResource` | [详细文档](copy-resource.md) | - -### 计算着色器 - -| 方法 | 文档 | -|------|------| -| `Dispatch` | [详细文档](dispatch.md) | - -### 生命周期 - -| 方法 | 文档 | -|------|------| -| `Shutdown` | [详细文档](shutdown.md) | +| [`Reset`](reset.md) | 重置命令列表 | +| [`Close`](close.md) | 关闭命令列表 | +| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 | +| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 | +| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 | +| [`SetViewport`](set-viewport.md) | 设置视口 | +| [`SetViewports`](set-viewports.md) | 设置多个视口 | +| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 | +| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 | +| [`SetRenderTargets`](set-render-targets.md) | 设置渲染目标 | +| [`SetDepthStencilState`](set-depth-stencil-state.md) | 设置深度模板状态 | +| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 | +| [`SetBlendState`](set-blend-state.md) | 设置混合状态 | +| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 | +| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 | +| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 | +| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 | +| [`Draw`](draw.md) | 绘制 | +| [`DrawIndexed`](draw-indexed.md) | 索引绘制 | +| [`Clear`](clear.md) | 清除 | +| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 | +| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 | +| [`CopyResource`](copy-resource.md) | 复制资源 | +| [`Dispatch`](dispatch.md) | 分发计算任务 | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | ## 使用示例 diff --git a/docs/api/rhi/command-queue/command-queue.md b/docs/api/rhi/command-queue/command-queue.md index 40916ad3..bb29210b 100644 --- a/docs/api/rhi/command-queue/command-queue.md +++ b/docs/api/rhi/command-queue/command-queue.md @@ -8,34 +8,17 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 命令执行 - -| 方法 | 文档 | -|------|------| -| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) | -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](methods.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `WaitForIdle` | [详细文档](wait-for-idle.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetType` | [详细文档](get-type.md) | -| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`ExecuteCommandLists`](execute-command-lists.md) | 执行命令列表 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](../../threading/task-group/wait.md) | 等待栅栏 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`WaitForIdle`](wait-for-idle.md) | 等待空闲 | +| [`GetType`](get-type.md) | 获取队列类型 | +| [`GetTimestampFrequency`](get-timestamp-frequency.md) | 获取时间戳频率 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 命令队列类型 (CommandQueueType) diff --git a/docs/api/rhi/d3d12/README.md b/docs/api/rhi/d3d12/README.md deleted file mode 100644 index 0c5b1e61..00000000 --- a/docs/api/rhi/d3d12/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# D3D12 后端组件 - -D3D12 后端已创建以下组件文件夹和文档： - -- `device/` - D3D12Device -- `buffer/` - D3D12Buffer -- `texture/` - D3D12Texture -- `command-list/` - D3D12CommandList -- `command-queue/` - D3D12CommandQueue -- `swap-chain/` - D3D12SwapChain -- `fence/` - D3D12Fence -- `shader/` - D3D12Shader -- `pipeline-state/` - D3D12PipelineState -- `sampler/` - D3D12Sampler -- `root-signature/` - D3D12RootSignature -- `descriptor-heap/` - D3D12DescriptorHeap -- `render-target-view/` - D3D12RenderTargetView -- `depth-stencil-view/` - D3D12DepthStencilView -- `shader-resource-view/` - D3D12ShaderResourceView -- `unordered-access-view/` - D3D12UnorderedAccessView -- `constant-buffer-view/` - D3D12ConstantBufferView -- `command-allocator/` - D3D12CommandAllocator -- `query-heap/` - D3D12QueryHeap -- `screenshot/` - D3D12Screenshot -- `types/` - D3D12 类型转换 -- `enums/` - D3D12 枚举转换 -- `common/` - D3D12 公共工具 - -每个组件文件夹包含: -- `{component}.md` - 类总览 -- `methods.md` - 方法详细文档 - -## 相关文档 - -- [D3D12 后端总览](overview.md) -- [RHI 抽象层](overview.md) diff --git a/docs/api/rhi/d3d12/buffer/buffer.md b/docs/api/rhi/d3d12/buffer/buffer.md index d4cdd597..90f3506a 100644 --- a/docs/api/rhi/d3d12/buffer/buffer.md +++ b/docs/api/rhi/d3d12/buffer/buffer.md @@ -4,30 +4,34 @@ **描述**: DirectX 12 缓冲区的 D3D12 实现，继承自 `RHIBuffer`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `InitializeFromExisting` | [详细文档](initialize-from-existing.md) | -| `InitializeWithData` | [详细文档](initialize-with-data.md) | -| `Shutdown` | [详细文档](shutdown.md) | -| `UpdateData` | [详细文档](update-data.md) | -| `Map` | [详细文档](map.md) | -| `Unmap` | [详细文档](unmap.md) | -| `SetData` | [详细文档](set-data.md) | -| `GetResource` | [详细文档](get-resource.md) | -| `GetDesc` | [详细文档](get-desc.md) | -| `GetGPUVirtualAddress` | [详细文档](get-gpu-virtual-address.md) | -| `GetGPUAddress` | [详细文档](get-gpu-address.md) | -| `GetSize` | [详细文档](get-size.md) | -| `GetState` / `SetState` | [详细文档](get-state.md) | -| `GetName` / `SetName` | [详细文档](get-name.md) | -| `GetStride` / `SetStride` | [详细文档](get-stride.md) | -| `GetBufferType` / `SetBufferType` | [详细文档](get-buffer-type.md) | -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`Initialize`](initialize.md) | 初始化缓冲区 | +| [`InitializeFromExisting`](initialize-from-existing.md) | 从现有资源初始化 | +| [`InitializeWithData`](initialize-with-data.md) | 初始化并写入数据 | +| [`Shutdown`](shutdown.md) | 关闭缓冲区 | +| [`UpdateData`](update-data.md) | 更新数据 | +| [`Map`](map.md) | 映射缓冲区 | +| [`Unmap`](unmap.md) | 取消映射 | +| [`SetData`](set-data.md) | 设置数据 | +| [`GetResource`](get-resource.md) | 获取 D3D12 资源 | +| [`GetDesc`](get-desc.md) | 获取描述符 | +| [`GetGPUVirtualAddress`](get-gpu-virtual-address.md) | 获取 GPU 虚拟地址 | +| [`GetGPUAddress`](get-gpu-address.md) | 获取 GPU 地址 | +| [`GetSize`](get-size.md) | 获取缓冲区大小 | +| [`GetState`](get-state.md) | 获取资源状态 | +| [`SetState`](../../buffer/set-state.md) | 设置资源状态 | +| [`GetName`](get-name.md) | 获取资源名称 | +| [`SetName`](../../buffer/set-name.md) | 设置资源名称 | +| [`GetStride`](get-stride.md) | 获取步长 | +| [`SetStride`](../../buffer/set-stride.md) | 设置步长 | +| [`GetBufferType`](get-buffer-type.md) | 获取缓冲区类型 | +| [`SetBufferType`](../../buffer/set-buffer-type.md) | 设置缓冲区类型 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIBuffer](../../buffer/buffer.md) - 抽象缓冲区接口 diff --git a/docs/api/rhi/d3d12/command-allocator/command-allocator.md b/docs/api/rhi/d3d12/command-allocator/command-allocator.md index dd754336..7a7dfa98 100644 --- a/docs/api/rhi/d3d12/command-allocator/command-allocator.md +++ b/docs/api/rhi/d3d12/command-allocator/command-allocator.md @@ -4,16 +4,16 @@ **描述**: DirectX 12 命令分配器的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) | -| `IsReady` | [详细文档](is-ready.md) | -| `GetCommandAllocator` | [详细文档](get-command-allocator.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化命令分配器 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令分配器 | +| [`Reset`](../../command-list/reset.md) | 重置命令分配器 | +| [`IsReady`](is-ready.md) | 检查是否就绪 | +| [`GetCommandAllocator`](get-command-allocator.md) | 获取 D3D12 命令分配器 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/command-list/command-list.md b/docs/api/rhi/d3d12/command-list/command-list.md index 06996d47..714fd926 100644 --- a/docs/api/rhi/d3d12/command-list/command-list.md +++ b/docs/api/rhi/d3d12/command-list/command-list.md @@ -4,139 +4,62 @@ **描述**: DirectX 12 命令列表的 D3D12 实现，继承自 `RHICommandList`。 -## 方法列表 +## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](../../command-list/shutdown.md) | -| `Reset` | [详细文档](../../command-list/reset.md) | -| `Close` | [详细文档](../../command-list/close.md) | -| `GetCommandList` | [详细文档](get-command-list.md) | - -### 资源屏障 - -| 方法 | 文档 | -|------|------| -| `TransitionBarrier` | [详细文档](transition-barrier.md) | -| `TransitionBarrierInternal` | [详细文档](transition-barrier-internal.md) | -| `UAVBarrier` | [详细文档](uav-barrier.md) | -| `AliasBarrier` | [详细文档](alias-barrier.md) | - -### 管线状态 - -| 方法 | 文档 | -|------|------| -| `SetPipelineState` | [详细文档](set-pipeline-state.md) | -| `SetRootSignature` | [详细文档](set-root-signature.md) | -| `SetPrimitiveTopology` | [详细文档](set-primitive-topology.md) | - -### 视口与裁剪 - -| 方法 | 文档 | -|------|------| -| `SetViewport` | [详细文档](set-viewport.md) | -| `SetViewports` | [详细文档](set-viewports.md) | -| `SetScissorRect` | [详细文档](set-scissor-rect.md) | -| `SetScissorRects` | [详细文档](set-scissor-rects.md) | - -### 渲染目标 - -| 方法 | 文档 | -|------|------| -| `SetRenderTargets` | [详细文档](set-render-targets.md) | -| `SetRenderTargetsInternal` | [详细文档](set-render-targets-internal.md) | -| `SetRenderTargetsHandle` | [详细文档](set-render-targets-handle.md) | - -### 顶点/索引缓冲区 - -| 方法 | 文档 | -|------|------| -| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) | -| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) | -| `SetIndexBuffer` | [详细文档](set-index-buffer.md) | - -### 描述符 - -| 方法 | 文档 | -|------|------| -| `SetDescriptorHeap` | [详细文档](set-descriptor-heap.md) | -| `SetDescriptorHeaps` | [详细文档](set-descriptor-heaps.md) | -| `SetGraphicsDescriptorTable` | [详细文档](set-graphics-descriptor-table.md) | -| `SetComputeDescriptorTable` | [详细文档](set-compute-descriptor-table.md) | - -### 根参数绑定 - -| 方法 | 文档 | -|------|------| -| `SetGraphicsRootConstantBufferView` | [详细文档](set-graphics-root-constant-buffer-view.md) | -| `SetGraphicsRoot32BitConstants` | [详细文档](set-graphics-root-32bit-constants.md) | -| `SetGraphicsRootDescriptorTable` | [详细文档](set-graphics-root-descriptor-table.md) | -| `SetGraphicsRootShaderResourceView` | [详细文档](set-graphics-root-shader-resource-view.md) | - -### 渲染状态 - -| 方法 | 文档 | -|------|------| -| `SetStencilRef` | [详细文档](set-stencil-ref.md) | -| `SetBlendFactor` | [详细文档](set-blend-factor.md) | -| `SetDepthBias` | [详细文档](set-depth-bias.md) | - -### 绘制 - -| 方法 | 文档 | -|------|------| -| `Draw` | [详细文档](draw.md) | -| `DrawIndexed` | [详细文档](draw-indexed.md) | -| `DrawInstancedIndirect` | [详细文档](draw-instanced-indirect.md) | -| `DrawIndexedInstancedIndirect` | [详细文档](draw-indexed-instanced-indirect.md) | - -### 清除 - -| 方法 | 文档 | -|------|------| -| `Clear` | [详细文档](../../command-list/clear.md) | -| `ClearRenderTarget` | [详细文档](clear-render-target.md) | -| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) | - -### 复制 - -| 方法 | 文档 | -|------|------| -| `CopyResource` | [详细文档](copy-resource.md) | -| `CopyBuffer` | [详细文档](copy-buffer.md) | -| `CopyTexture` | [详细文档](copy-texture.md) | - -### 查询 - -| 方法 | 文档 | -|------|------| -| `BeginQuery` | [详细文档](begin-query.md) | -| `EndQuery` | [详细文档](end-query.md) | -| `ResolveQueryData` | [详细文档](resolve-query-data.md) | - -### 计算 - -| 方法 | 文档 | -|------|------| -| `Dispatch` | [详细文档](dispatch.md) | -| `DispatchIndirect` | [详细文档](dispatch-indirect.md) | - -### Bundle - -| 方法 | 文档 | -|------|------| -| `ExecuteBundle` | [详细文档](execute-bundle.md) | - -### 状态管理 - -| 方法 | 文档 | -|------|------| -| `GetResourceState` | [详细文档](get-resource-state.md) | -| `TrackResource` | [详细文档](track-resource.md) | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令列表 | +| [`Reset`](../../command-list/reset.md) | 重置命令列表 | +| [`Close`](../../command-list/close.md) | 关闭命令列表 | +| [`GetCommandList`](get-command-list.md) | 获取 D3D12 命令列表 | +| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 | +| [`TransitionBarrierInternal`](transition-barrier-internal.md) | 内部资源状态转换 | +| [`UAVBarrier`](uav-barrier.md) | UAV 屏障 | +| [`AliasBarrier`](alias-barrier.md) | 别名屏障 | +| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 | +| [`SetRootSignature`](set-root-signature.md) | 设置根签名 | +| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 | +| [`SetViewport`](set-viewport.md) | 设置视口 | +| [`SetViewports`](set-viewports.md) | 设置多个视口 | +| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 | +| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 | +| [`SetRenderTargets`](set-render-targets.md) | 设置渲染目标 | +| [`SetRenderTargetsInternal`](set-render-targets-internal.md) | 内部渲染目标设置 | +| [`SetRenderTargetsHandle`](set-render-targets-handle.md) | 句柄渲染目标设置 | +| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 | +| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 | +| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 | +| [`SetDescriptorHeap`](set-descriptor-heap.md) | 设置描述符堆 | +| [`SetDescriptorHeaps`](set-descriptor-heaps.md) | 设置多个描述符堆 | +| [`SetGraphicsDescriptorTable`](set-graphics-descriptor-table.md) | 设置图形描述符表 | +| [`SetComputeDescriptorTable`](set-compute-descriptor-table.md) | 设置计算描述符表 | +| [`SetGraphicsRootConstantBufferView`](set-graphics-root-constant-buffer-view.md) | 设置图形根常量缓冲视图 | +| [`SetGraphicsRoot32BitConstants`](set-graphics-root-32bit-constants.md) | 设置图形根 32 位常量 | +| [`SetGraphicsRootDescriptorTable`](set-graphics-root-descriptor-table.md) | 设置图形根描述符表 | +| [`SetGraphicsRootShaderResourceView`](set-graphics-root-shader-resource-view.md) | 设置图形根着色器资源视图 | +| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 | +| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 | +| [`SetDepthBias`](set-depth-bias.md) | 设置深度偏移 | +| [`Draw`](draw.md) | 绘制 | +| [`DrawIndexed`](draw-indexed.md) | 索引绘制 | +| [`DrawInstancedIndirect`](draw-instanced-indirect.md) | 实例化间接绘制 | +| [`DrawIndexedInstancedIndirect`](draw-indexed-instanced-indirect.md) | 索引实例化间接绘制 | +| [`Clear`](../../command-list/clear.md) | 清除 | +| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 | +| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 | +| [`CopyResource`](copy-resource.md) | 复制资源 | +| [`CopyBuffer`](copy-buffer.md) | 复制缓冲区 | +| [`CopyTexture`](copy-texture.md) | 复制纹理 | +| [`BeginQuery`](begin-query.md) | 开始查询 | +| [`EndQuery`](end-query.md) | 结束查询 | +| [`ResolveQueryData`](resolve-query-data.md) | 解析查询数据 | +| [`Dispatch`](dispatch.md) | 分发计算任务 | +| [`DispatchIndirect`](dispatch-indirect.md) | 间接分发计算任务 | +| [`ExecuteBundle`](execute-bundle.md) | 执行 Bundle | +| [`GetResourceState`](get-resource-state.md) | 获取资源状态 | +| [`TrackResource`](track-resource.md) | 跟踪资源 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHICommandList](../../command-list/command-list.md) - 抽象命令列表接口 diff --git a/docs/api/rhi/d3d12/command-queue/command-queue.md b/docs/api/rhi/d3d12/command-queue/command-queue.md index 9c8e0111..c717e41b 100644 --- a/docs/api/rhi/d3d12/command-queue/command-queue.md +++ b/docs/api/rhi/d3d12/command-queue/command-queue.md @@ -4,23 +4,23 @@ **描述**: DirectX 12 命令队列的 D3D12 实现，继承自 `RHICommandQueue`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) | -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](../../../threading/task-group/wait.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `WaitForIdle` | [详细文档](wait-for-idle.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | -| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) | -| `GetCommandQueue` | [详细文档](get-command-queue.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化命令队列 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令队列 | +| [`ExecuteCommandLists`](execute-command-lists.md) | 执行命令列表 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`WaitForIdle`](wait-for-idle.md) | 等待空闲 | +| [`GetType`](../../command-queue/get-type.md) | 获取队列类型 | +| [`GetTimestampFrequency`](get-timestamp-frequency.md) | 获取时间戳频率 | +| [`GetCommandQueue`](get-command-queue.md) | 获取 D3D12 命令队列 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHICommandQueue](../../command-queue/command-queue.md) - 抽象命令队列接口 diff --git a/docs/api/rhi/d3d12/common/common.md b/docs/api/rhi/d3d12/common/common.md index a48c8b03..0c94b9bf 100644 --- a/docs/api/rhi/d3d12/common/common.md +++ b/docs/api/rhi/d3d12/common/common.md @@ -64,4 +64,4 @@ ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/constant-buffer-view/constant-buffer-view.md b/docs/api/rhi/d3d12/constant-buffer-view/constant-buffer-view.md index 02b7a125..f59eb66b 100644 --- a/docs/api/rhi/d3d12/constant-buffer-view/constant-buffer-view.md +++ b/docs/api/rhi/d3d12/constant-buffer-view/constant-buffer-view.md @@ -4,14 +4,14 @@ **描述**: DirectX 12 常量缓冲区视图的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化常量缓冲区视图 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭常量缓冲区视图 | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/overview.md b/docs/api/rhi/d3d12/d3d12.md similarity index 100% rename from docs/api/rhi/d3d12/overview.md rename to docs/api/rhi/d3d12/d3d12.md diff --git a/docs/api/rhi/d3d12/depth-stencil-view/depth-stencil-view.md b/docs/api/rhi/d3d12/depth-stencil-view/depth-stencil-view.md index 8b8e6fd8..e528ab16 100644 --- a/docs/api/rhi/d3d12/depth-stencil-view/depth-stencil-view.md +++ b/docs/api/rhi/d3d12/depth-stencil-view/depth-stencil-view.md @@ -4,16 +4,16 @@ **描述**: DirectX 12 深度模板视图的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `InitializeAt` | [详细文档](initialize-at.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化深度模板视图 | +| [`InitializeAt`](initialize-at.md) | 在指定位置初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭深度模板视图 | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | +| [`CreateDesc`](create-desc.md) | 创建描述符（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md b/docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md index 8555d894..d17ea0f5 100644 --- a/docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md +++ b/docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md @@ -4,25 +4,24 @@ **描述**: DirectX 12 描述符堆的 D3D12 实现，继承自 `RHIDescriptorPool`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` (params) | [详细文档](../../../threading/task-system/initialize.md) | -| `Initialize` (desc) | [详细文档](initialize-from-desc.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetDescriptorHeap` | [详细文档](get-descriptor-heap.md) | -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | -| `GetGPUDescriptorHandle` | [详细文档](get-gpu-descriptor-handle.md) | -| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | -| `GetDescriptorSize` | [详细文档](get-descriptor-size.md) | -| `GetCPUDescriptorHandleForHeapStart` | [详细文档](get-cpu-descriptor-handle-for-heap-start.md) | -| `GetGPUDescriptorHandleForHeapStart` | [详细文档](get-gpu-descriptor-handle-for-heap-start.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | +| [`Initialize`](initialize-from-desc.md) | 从描述符初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭描述符堆 | +| [`GetDescriptorHeap`](get-descriptor-heap.md) | 获取 D3D12 描述符堆 | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | +| [`GetGPUDescriptorHandle`](get-gpu-descriptor-handle.md) | 获取 GPU 描述符句柄 | +| [`GetDescriptorCount`](get-descriptor-count.md) | 获取描述符数量 | +| [`GetType`](../../command-queue/get-type.md) | 获取描述符类型 | +| [`GetDescriptorSize`](get-descriptor-size.md) | 获取描述符大小 | +| [`GetCPUDescriptorHandleForHeapStart`](get-cpu-descriptor-handle-for-heap-start.md) | 获取堆起始 CPU 句柄 | +| [`GetGPUDescriptorHandleForHeapStart`](get-gpu-descriptor-handle-for-heap-start.md) | 获取堆起始 GPU 句柄 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`CreateDesc`](create-desc.md) | 创建描述符（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIDescriptorPool](../../descriptor-pool/descriptor-pool.md) - 抽象描述符池接口 diff --git a/docs/api/rhi/d3d12/device/device.md b/docs/api/rhi/d3d12/device/device.md index 1e5d9204..ac1b59c7 100644 --- a/docs/api/rhi/d3d12/device/device.md +++ b/docs/api/rhi/d3d12/device/device.md @@ -6,37 +6,30 @@ ## 公共方法 -### 继承方法 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../device/initialize.md) | -| `Shutdown` | [详细文档](../../device/shutdown.md) | -| `CreateBuffer` | [详细文档](../../device/create-buffer.md) | -| `CreateTexture` | [详细文档](../../device/create-texture.md) | -| `CreateSwapChain` | [详细文档](../../device/create-swap-chain.md) | -| `CreateCommandList` | [详细文档](../../device/create-command-list.md) | -| `CreateCommandQueue` | [详细文档](../../device/create-command-queue.md) | -| `CompileShader` | [详细文档](../../device/compile-shader.md) | -| `CreatePipelineState` | [详细文档](../../device/create-pipeline-state.md) | -| `CreateFence` | [详细文档](../../device/create-fence.md) | -| `CreateSampler` | [详细文档](../../device/create-sampler.md) | -| `GetCapabilities` | [详细文档](../../device/get-capabilities.md) | -| `GetDeviceInfo` | [详细文档](../../device/get-device-info.md) | -| `GetNativeDevice` | [详细文档](../../device/get-native-device.md) | - -### D3D12 特有方法 - -| 方法 | 文档 | -|------|------| -| `GetDevice` | [详细文档](get-device.md) | -| `GetFactory` | [详细文档](get-factory.md) | -| `GetAdapterInfo` | [详细文档](get-adapter-info.md) | -| `EnumerateAdapters` | [详细文档](enumerate-adapters.md) | -| `GetDescriptorHandleIncrementSize` | [详细文档](get-descriptor-handle-increment-size.md) | -| `CheckFeatureSupport` | [详细文档](check-feature-support.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化设备 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭设备 | +| [`CreateBuffer`](../../device/create-buffer.md) | 创建缓冲区 | +| [`CreateTexture`](../../device/create-texture.md) | 创建纹理 | +| [`CreateSwapChain`](../../device/create-swap-chain.md) | 创建交换链 | +| [`CreateCommandList`](../../device/create-command-list.md) | 创建命令列表 | +| [`CreateCommandQueue`](../../device/create-command-queue.md) | 创建命令队列 | +| [`CompileShader`](../../device/compile-shader.md) | 编译着色器 | +| [`CreatePipelineState`](../../device/create-pipeline-state.md) | 创建管线状态 | +| [`CreateFence`](../../device/create-fence.md) | 创建栅栏 | +| [`CreateSampler`](../../device/create-sampler.md) | 创建采样器 | +| [`GetCapabilities`](../../device/get-capabilities.md) | 获取设备能力 | +| [`GetDeviceInfo`](../../device/get-device-info.md) | 获取设备信息 | +| [`GetNativeDevice`](../../device/get-native-device.md) | 获取原生设备 | +| [`GetDevice`](get-device.md) | 获取 D3D12 设备 | +| [`GetFactory`](get-factory.md) | 获取 D3D12 工厂 | +| [`GetAdapterInfo`](get-adapter-info.md) | 获取适配器信息 | +| [`EnumerateAdapters`](enumerate-adapters.md) | 枚举适配器 | +| [`GetDescriptorHandleIncrementSize`](get-descriptor-handle-increment-size.md) | 获取描述符增量大小 | +| [`CheckFeatureSupport`](check-feature-support.md) | 检查特性支持 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIDevice](../../device/device.md) - 抽象设备接口 diff --git a/docs/api/rhi/d3d12/enums/enums.md b/docs/api/rhi/d3d12/enums/enums.md index a9060c16..b43015c0 100644 --- a/docs/api/rhi/d3d12/enums/enums.md +++ b/docs/api/rhi/d3d12/enums/enums.md @@ -33,5 +33,5 @@ ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [D3D12Types](../../types/types.md) - 类型转换 diff --git a/docs/api/rhi/d3d12/fence/fence.md b/docs/api/rhi/d3d12/fence/fence.md index 210240f9..7b75051e 100644 --- a/docs/api/rhi/d3d12/fence/fence.md +++ b/docs/api/rhi/d3d12/fence/fence.md @@ -4,21 +4,21 @@ **描述**: DirectX 12 栅栏同步对象的 D3D12 实现，继承自 `RHIFence`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](../../../threading/task-group/wait.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `IsSignaled` | [详细文档](is-signaled.md) | -| `GetEventHandle` | [详细文档](get-event-handle.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetFence` | [详细文档](get-fence.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化栅栏 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭栅栏 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`IsSignaled`](is-signaled.md) | 检查是否已信号 | +| [`GetEventHandle`](get-event-handle.md) | 获取事件句柄 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetFence`](get-fence.md) | 获取 D3D12 栅栏 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIFence](../../fence/fence.md) - 抽象栅栏接口 diff --git a/docs/api/rhi/d3d12/pipeline-state/pipeline-state.md b/docs/api/rhi/d3d12/pipeline-state/pipeline-state.md index cdf1c88a..e2e2442b 100644 --- a/docs/api/rhi/d3d12/pipeline-state/pipeline-state.md +++ b/docs/api/rhi/d3d12/pipeline-state/pipeline-state.md @@ -4,21 +4,21 @@ **描述**: DirectX 12 管线状态对象的 D3D12 实现，继承自 `RHIPipelineState`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetPipelineState` | [详细文档](get-pipeline-state.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | -| `Bind` | [详细文档](../../shader/bind.md) | -| `Unbind` | [详细文档](../../shader/unbind.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | -| `CreateInputElement` (static) | [详细文档](create-input-element.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化管线状态 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭管线状态 | +| [`GetPipelineState`](get-pipeline-state.md) | 获取 D3D12 管线状态对象 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetType`](../../command-queue/get-type.md) | 获取管线类型 | +| [`Bind`](../../shader/bind.md) | 绑定管线状态 | +| [`Unbind`](../../shader/unbind.md) | 解绑管线状态 | +| [`CreateDesc`](create-desc.md) | 创建管线状态描述符（静态） | +| [`CreateInputElement`](create-input-element.md) | 创建输入元素描述符（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIPipelineState](../../pipeline-state/pipeline-state.md) - 抽象管线状态接口 diff --git a/docs/api/rhi/d3d12/query-heap/query-heap.md b/docs/api/rhi/d3d12/query-heap/query-heap.md index 54d80211..06062b60 100644 --- a/docs/api/rhi/d3d12/query-heap/query-heap.md +++ b/docs/api/rhi/d3d12/query-heap/query-heap.md @@ -4,17 +4,17 @@ **描述**: DirectX 12 查询堆的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetQueryHeap` | [详细文档](get-query-heap.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | -| `GetCount` | [详细文档](get-count.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化查询堆 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭查询堆 | +| [`GetQueryHeap`](get-query-heap.md) | 获取 D3D12 查询堆 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetType`](../../command-queue/get-type.md) | 获取查询类型 | +| [`GetCount`](get-count.md) | 获取查询数量 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/render-target-view/render-target-view.md b/docs/api/rhi/d3d12/render-target-view/render-target-view.md index ca9a1546..16e7ac91 100644 --- a/docs/api/rhi/d3d12/render-target-view/render-target-view.md +++ b/docs/api/rhi/d3d12/render-target-view/render-target-view.md @@ -4,16 +4,16 @@ **描述**: DirectX 12 渲染目标视图的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `InitializeAt` | [详细文档](initialize-at.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化渲染目标视图 | +| [`InitializeAt`](initialize-at.md) | 在指定位置初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭渲染目标视图 | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | +| [`CreateDesc`](create-desc.md) | 创建描述符（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/root-signature/root-signature.md b/docs/api/rhi/d3d12/root-signature/root-signature.md index 80ea67db..ec578f60 100644 --- a/docs/api/rhi/d3d12/root-signature/root-signature.md +++ b/docs/api/rhi/d3d12/root-signature/root-signature.md @@ -4,25 +4,25 @@ **描述**: DirectX 12 根签名的 D3D12 实现。**不继承 RHI 抽象接口**，是 D3D12 特有的封装类。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetRootSignature` | [详细文档](get-root-signature.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetParameterCount` | [详细文档](get-parameter-count.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | -| `CreateCBV` (static) | [详细文档](create-cbv.md) | -| `CreateSRV` (static) | [详细文档](create-srv.md) | -| `CreateUAV` (static) | [详细文档](create-uav.md) | -| `Create32BitConstants` (static) | [详细文档](create-32bit-constants.md) | -| `CreateDescriptorTable` (static) | [详细文档](create-descriptor-table.md) | -| `CreateStaticSampler` (static) | [详细文档](create-static-sampler.md) | -| `CreateSamplerDesc` (static) | [详细文档](create-sampler-desc.md) | -| `CreateDescriptorRange` (static) | [详细文档](create-descriptor-range.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化根签名 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭根签名 | +| [`GetRootSignature`](get-root-signature.md) | 获取 D3D12 根签名 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetParameterCount`](get-parameter-count.md) | 获取参数数量 | +| [`CreateDesc`](create-desc.md) | 创建根签名描述符（静态） | +| [`CreateCBV`](create-cbv.md) | 创建常量缓冲区视图（静态） | +| [`CreateSRV`](create-srv.md) | 创建着色器资源视图（静态） | +| [`CreateUAV`](create-uav.md) | 创建无序访问视图（静态） | +| [`Create32BitConstants`](create-32bit-constants.md) | 创建 32 位常量（静态） | +| [`CreateDescriptorTable`](create-descriptor-table.md) | 创建描述符表（静态） | +| [`CreateStaticSampler`](create-static-sampler.md) | 创建静态采样器（静态） | +| [`CreateSamplerDesc`](create-sampler-desc.md) | 创建采样器描述符（静态） | +| [`CreateDescriptorRange`](create-descriptor-range.md) | 创建描述符范围（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/sampler/sampler.md b/docs/api/rhi/d3d12/sampler/sampler.md index c3f9cc12..fab87f1d 100644 --- a/docs/api/rhi/d3d12/sampler/sampler.md +++ b/docs/api/rhi/d3d12/sampler/sampler.md @@ -4,18 +4,19 @@ **描述**: DirectX 12 采样器的 D3D12 实现，继承自 `RHISampler`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetDesc` | [详细文档](../buffer/get-desc.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetID` | [详细文档](get-id.md) | -| `Bind` / `Unbind` | [详细文档](../../shader/bind.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化采样器 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭采样器 | +| [`GetDesc`](../buffer/get-desc.md) | 获取采样器描述符 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetID`](get-id.md) | 获取采样器 ID | +| [`Bind`](../../shader/bind.md) | 绑定采样器 | +| [`Unbind`](../../shader/unbind.md) | 解绑采样器 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHISampler](../../sampler/sampler.md) - 抽象采样器接口 diff --git a/docs/api/rhi/d3d12/screenshot/screenshot.md b/docs/api/rhi/d3d12/screenshot/screenshot.md index 5efc2d99..a8c2f484 100644 --- a/docs/api/rhi/d3d12/screenshot/screenshot.md +++ b/docs/api/rhi/d3d12/screenshot/screenshot.md @@ -4,13 +4,13 @@ **描述**: D3D12 截图工具类，提供屏幕截图捕获功能。**所有方法均为静态方法**。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Capture` | [详细文档](capture.md) | -| `CopyToReadbackAndSave` | [详细文档](copy-to-readback-and-save.md) | +| [`Capture`](capture.md) | 捕获截图 | +| [`CopyToReadbackAndSave`](copy-to-readback-and-save.md) | 复制到回读缓冲并保存 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/shader-resource-view/shader-resource-view.md b/docs/api/rhi/d3d12/shader-resource-view/shader-resource-view.md index 3824e1a9..fe40f876 100644 --- a/docs/api/rhi/d3d12/shader-resource-view/shader-resource-view.md +++ b/docs/api/rhi/d3d12/shader-resource-view/shader-resource-view.md @@ -4,16 +4,16 @@ **描述**: DirectX 12 着色器资源视图的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) | -| `InitializeAt` | [详细文档](initialize-at.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | -| `CreateDesc` (static) | [详细文档](create-desc.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化着色器资源视图 | +| [`InitializeAt`](initialize-at.md) | 在指定位置初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭着色器资源视图 | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | +| [`CreateDesc`](create-desc.md) | 创建描述符（静态） | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/d3d12/shader/shader.md b/docs/api/rhi/d3d12/shader/shader.md index 4fab3dbf..0acf341b 100644 --- a/docs/api/rhi/d3d12/shader/shader.md +++ b/docs/api/rhi/d3d12/shader/shader.md @@ -4,24 +4,25 @@ **描述**: DirectX 12 着色器的 D3D12 实现，继承自 `RHIShader`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `CompileFromFile` | [详细文档](../../shader/compile-from-file.md) | -| `Compile` | [详细文档](../../shader/compile.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetD3D12Bytecode` | [详细文档](get-d3d12-bytecode.md) | -| `GetBytecode` | [详细文档](get-bytecode.md) | -| `GetBytecodeSize` | [详细文档](get-bytecode-size.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | -| `GetInputLayout` | [详细文档](get-input-layout.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `IsValid` | [详细文档](../../shader/is-valid.md) | -| `Bind` / `Unbind` | [详细文档](../../shader/bind.md) | -| `SetInt` / `SetFloat` / `SetVec3` / `SetVec4` / `SetMat4` | [详细文档](set-uniforms.md) | +| [`CompileFromFile`](../../shader/compile-from-file.md) | 从文件编译着色器 | +| [`Compile`](../../shader/compile.md) | 从源码编译着色器 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭着色器 | +| [`GetD3D12Bytecode`](get-d3d12-bytecode.md) | 获取 D3D12 字节码 | +| [`GetBytecode`](get-bytecode.md) | 获取字节码 | +| [`GetBytecodeSize`](get-bytecode-size.md) | 获取字节码大小 | +| [`GetType`](../../command-queue/get-type.md) | 获取着色器类型 | +| [`GetInputLayout`](get-input-layout.md) | 获取输入布局 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`IsValid`](../../shader/is-valid.md) | 检查是否有效 | +| [`Bind`](../../shader/bind.md) | 绑定着色器 | +| [`Unbind`](../../shader/unbind.md) | 解绑着色器 | +| [`SetUniforms`](set-uniforms.md) | 设置 uniform 变量 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHIShader](../../shader/shader.md) - 抽象着色器接口 diff --git a/docs/api/rhi/d3d12/swap-chain/swap-chain.md b/docs/api/rhi/d3d12/swap-chain/swap-chain.md index e2f34086..6d742855 100644 --- a/docs/api/rhi/d3d12/swap-chain/swap-chain.md +++ b/docs/api/rhi/d3d12/swap-chain/swap-chain.md @@ -4,27 +4,26 @@ **描述**: DirectX 12 交换链的 D3D12 实现，继承自 `RHISwapChain`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` (from factory) | [详细文档](../../../threading/task-system/initialize.md) | -| `Initialize` (from swapchain) | [详细文档](initialize-from-swapchain.md) | -| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) | -| `GetCurrentBackBufferIndex` | [详细文档](get-current-back-buffer-index.md) | -| `GetCurrentBackBuffer` | [详细文档](get-current-back-buffer.md) | -| `GetBackBuffer` | [详细文档](get-back-buffer.md) | -| `Present` | [详细文档](present.md) | -| `Resize` | [详细文档](../../../containers/array/resize.md) | -| `SetFullscreen` | [详细文档](set-fullscreen.md) | -| `IsFullscreen` | [详细文档](is-fullscreen.md) | -| `ShouldClose` | [详细文档](should-close.md) | -| `SetShouldClose` | [详细文档](set-should-close.md) | -| `PollEvents` | [详细文档](poll-events.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetSwapChain` | [详细文档](get-swap-chain.md) | +| [`Initialize`](initialize-from-swapchain.md) | 从交换链初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭交换链 | +| [`GetCurrentBackBufferIndex`](get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 | +| [`GetCurrentBackBuffer`](get-current-back-buffer.md) | 获取当前后台缓冲区 | +| [`GetBackBuffer`](get-back-buffer.md) | 获取后台缓冲区 | +| [`Present`](present.md) | 呈现画面 | +| [`Resize`](../../swap-chain/resize.md) | 调整交换链大小 | +| [`SetFullscreen`](set-fullscreen.md) | 设置全屏模式 | +| [`IsFullscreen`](is-fullscreen.md) | 检查是否全屏 | +| [`ShouldClose`](should-close.md) | 检查是否应关闭 | +| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 | +| [`PollEvents`](poll-events.md) | 处理窗口事件 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetSwapChain`](get-swap-chain.md) | 获取 D3D12 交换链 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHISwapChain](../../swap-chain/swap-chain.md) - 抽象交换链接口 diff --git a/docs/api/rhi/d3d12/texture/texture.md b/docs/api/rhi/d3d12/texture/texture.md index af72ba53..fe55dfaf 100644 --- a/docs/api/rhi/d3d12/texture/texture.md +++ b/docs/api/rhi/d3d12/texture/texture.md @@ -4,30 +4,32 @@ **描述**: DirectX 12 纹理的 D3D12 实现，继承自 `RHITexture`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `InitializeFromExisting` | [详细文档](../buffer/initialize-from-existing.md) | -| `InitializeFromData` | [详细文档](initialize-from-data.md) | -| `InitializeDepthStencil` | [详细文档](initialize-depth-stencil.md) | -| `Shutdown` | [详细文档](../../texture/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) | +| [`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) | 获取 D3D12 资源 | +| [`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) | 获取 Mip 级别 | +| [`GetArraySize`](get-array-size.md) | 获取数组大小 | +| [`GetGPUAddress`](../buffer/get-gpu-address.md) | 获取 GPU 地址 | +| [`GetSize`](../../buffer/get-size.md) | 获取纹理大小 | +| [`GetName`](../../buffer/get-name.md) | 获取纹理名称 | +| [`SetName`](../../buffer/set-name.md) | 设置纹理名称 | +| [`GetFormat`](../../texture/get-format.md) | 获取纹理格式 | +| [`GetTextureType`](../../texture/get-texture-type.md) | 获取纹理类型 | +| [`GetState`](../../buffer/get-state.md) | 获取资源状态 | +| [`SetState`](../../buffer/set-state.md) | 设置资源状态 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [RHITexture](../../texture/texture.md) - 抽象纹理接口 diff --git a/docs/api/rhi/d3d12/types/types.md b/docs/api/rhi/d3d12/types/types.md index 38ae1b85..d4a60a2f 100644 --- a/docs/api/rhi/d3d12/types/types.md +++ b/docs/api/rhi/d3d12/types/types.md @@ -20,5 +20,5 @@ ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) - [D3D12Enum](../../enums/enums.md) - 枚举值转换 diff --git a/docs/api/rhi/d3d12/unordered-access-view/unordered-access-view.md b/docs/api/rhi/d3d12/unordered-access-view/unordered-access-view.md index 3dd2dc4f..05ec467c 100644 --- a/docs/api/rhi/d3d12/unordered-access-view/unordered-access-view.md +++ b/docs/api/rhi/d3d12/unordered-access-view/unordered-access-view.md @@ -4,12 +4,12 @@ **描述**: DirectX 12 无序访问视图的 D3D12 实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) | +| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 | ## 相关文档 -- [D3D12 后端总览](../overview.md) +- [D3D12 后端总览](../../opengl/overview.md) diff --git a/docs/api/rhi/descriptor-pool/descriptor-pool.md b/docs/api/rhi/descriptor-pool/descriptor-pool.md index cbe7ab7e..cc9ce688 100644 --- a/docs/api/rhi/descriptor-pool/descriptor-pool.md +++ b/docs/api/rhi/descriptor-pool/descriptor-pool.md @@ -8,20 +8,13 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](methods.md) | -| `Shutdown` | [详细文档](methods.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](methods.md) | -| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) | -| `GetType` | [详细文档](methods.md) | +| [`Initialize`](../../threading/task-system/initialize.md) | 初始化描述符池 | +| [`Shutdown`](../../threading/task-system/shutdown.md) | 关闭并释放资源 | +| [`GetNativeHandle`](../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetDescriptorCount`](get-descriptor-count.md) | 获取描述符数量 | +| [`GetType`](../command-queue/get-type.md) | 获取描述符类型 | ## 相关文档 diff --git a/docs/api/rhi/device/device.md b/docs/api/rhi/device/device.md index 63a60662..cbe249db 100644 --- a/docs/api/rhi/device/device.md +++ b/docs/api/rhi/device/device.md @@ -12,34 +12,22 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `Shutdown` | [详细文档](shutdown.md) | - -### 资源创建 - -| 方法 | 文档 | -|------|------| -| `CreateBuffer` | [详细文档](create-buffer.md) | -| `CreateTexture` | [详细文档](create-texture.md) | -| `CreateSwapChain` | [详细文档](create-swap-chain.md) | -| `CreateCommandList` | [详细文档](create-command-list.md) | -| `CreateCommandQueue` | [详细文档](create-command-queue.md) | -| `CompileShader` | [详细文档](compile-shader.md) | -| `CreatePipelineState` | [详细文档](create-pipeline-state.md) | -| `CreateFence` | [详细文档](create-fence.md) | -| `CreateSampler` | [详细文档](create-sampler.md) | - -### 设备信息 - -| 方法 | 文档 | -|------|------| -| `GetCapabilities` | [详细文档](get-capabilities.md) | -| `GetDeviceInfo` | [详细文档](get-device-info.md) | -| `GetNativeDevice` | [详细文档](get-native-device.md) | +| [`Initialize`](initialize.md) | 初始化设备 | +| [`Shutdown`](shutdown.md) | 关闭设备 | +| [`CreateBuffer`](create-buffer.md) | 创建缓冲区 | +| [`CreateTexture`](create-texture.md) | 创建纹理 | +| [`CreateSwapChain`](create-swap-chain.md) | 创建交换链 | +| [`CreateCommandList`](create-command-list.md) | 创建命令列表 | +| [`CreateCommandQueue`](create-command-queue.md) | 创建命令队列 | +| [`CompileShader`](compile-shader.md) | 编译着色器 | +| [`CreatePipelineState`](create-pipeline-state.md) | 创建管线状态 | +| [`CreateFence`](create-fence.md) | 创建栅栏 | +| [`CreateSampler`](create-sampler.md) | 创建采样器 | +| [`GetCapabilities`](get-capabilities.md) | 获取设备能力 | +| [`GetDeviceInfo`](get-device-info.md) | 获取设备信息 | +| [`GetNativeDevice`](get-native-device.md) | 获取原生设备 | ## 使用示例 diff --git a/docs/api/rhi/factory/factory.md b/docs/api/rhi/factory/factory.md index e3f997ba..8b0729d5 100644 --- a/docs/api/rhi/factory/factory.md +++ b/docs/api/rhi/factory/factory.md @@ -12,10 +12,10 @@ ## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `CreateRHIDevice(RHIType)` | [详细文档](create-rhi-device-type.md) | -| `CreateRHIDevice(std::string)` | [详细文档](create-rhi-device-string.md) | +| [`CreateRHIDevice(RHIType)`](create-rhi-device-type.md) | 使用枚举类型创建 RHI 设备 | +| [`CreateRHIDevice(std::string)`](create-rhi-device-string.md) | 使用字符串创建 RHI 设备 | ## 类型映射 diff --git a/docs/api/rhi/fence/fence.md b/docs/api/rhi/fence/fence.md index b4302496..cf7592ec 100644 --- a/docs/api/rhi/fence/fence.md +++ b/docs/api/rhi/fence/fence.md @@ -8,26 +8,14 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 同步操作 - -| 方法 | 文档 | -|------|------| -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](wait.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `IsSignaled` | [详细文档](is-signaled.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](wait.md) | 等待栅栏 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`IsSignaled`](is-signaled.md) | 检查是否已信号 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 使用示例 diff --git a/docs/api/rhi/opengl/README.md b/docs/api/rhi/opengl/README.md index 0fab2897..a2e4a91a 100644 --- a/docs/api/rhi/opengl/README.md +++ b/docs/api/rhi/opengl/README.md @@ -23,4 +23,4 @@ OpenGL 后端已创建以下组件文件夹和文档： ## 相关文档 - [OpenGL 后端总览](overview.md) -- [RHI 抽象层](../d3d12/overview.md) +- [RHI 抽象层](overview.md) diff --git a/docs/api/rhi/opengl/buffer/buffer.md b/docs/api/rhi/opengl/buffer/buffer.md index d5945140..7dc0134c 100644 --- a/docs/api/rhi/opengl/buffer/buffer.md +++ b/docs/api/rhi/opengl/buffer/buffer.md @@ -4,29 +4,33 @@ **描述**: OpenGL 缓冲区的实现，继承自 `RHIBuffer`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `InitializeVertexBuffer` | [详细文档](initialize-vertex-buffer.md) | -| `InitializeIndexBuffer` | [详细文档](initialize-index-buffer.md) | -| `Shutdown` | [详细文档](../../buffer/shutdown.md) | -| `Bind` | [详细文档](bind.md) | -| `Unbind` | [详细文档](unbind.md) | -| `BindBase` | [详细文档](bind-base.md) | -| `Map` | [详细文档](../../buffer/map.md) | -| `Unmap` | [详细文档](../../buffer/unmap.md) | -| `SetData` | [详细文档](../../buffer/set-data.md) | -| `GetID` | [详细文档](get-id.md) | -| `GetSize` | [详细文档](../../buffer/get-size.md) | -| `GetType` | [详细文档](get-type.md) | -| `IsDynamic` | [详细文档](is-dynamic.md) | -| `GetBufferType` / `SetBufferType` | [详细文档](../../buffer/get-buffer-type.md) | -| `GetStride` / `SetStride` | [详细文档](../../buffer/get-stride.md) | -| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) | -| `GetState` / `SetState` | [详细文档](../../buffer/get-state.md) | -| `GetName` / `SetName` | [详细文档](../../buffer/get-name.md) | +| [`Initialize`](initialize.md) | 初始化缓冲区 | +| [`InitializeVertexBuffer`](initialize-vertex-buffer.md) | 初始化顶点缓冲 | +| [`InitializeIndexBuffer`](initialize-index-buffer.md) | 初始化索引缓冲 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭缓冲区 | +| [`Bind`](bind.md) | 绑定缓冲区 | +| [`Unbind`](unbind.md) | 解绑缓冲区 | +| [`BindBase`](bind-base.md) | 绑定到基准点 | +| [`Map`](../../buffer/map.md) | 映射缓冲区 | +| [`Unmap`](../../buffer/unmap.md) | 取消映射 | +| [`SetData`](../../buffer/set-data.md) | 设置数据 | +| [`GetID`](get-id.md) | 获取 OpenGL 缓冲 ID | +| [`GetSize`](../../buffer/get-size.md) | 获取缓冲区大小 | +| [`GetType`](get-type.md) | 获取缓冲区类型 | +| [`IsDynamic`](is-dynamic.md) | 检查是否动态 | +| [`GetBufferType`](../../buffer/get-buffer-type.md) | 获取缓冲区类型 | +| [`SetBufferType`](../../buffer/set-buffer-type.md) | 设置缓冲区类型 | +| [`GetStride`](../../buffer/get-stride.md) | 获取步长 | +| [`SetStride`](../../buffer/set-stride.md) | 设置步长 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetState`](../../buffer/get-state.md) | 获取资源状态 | +| [`SetState`](../../buffer/set-state.md) | 设置资源状态 | +| [`GetName`](../../buffer/get-name.md) | 获取资源名称 | +| [`SetName`](../../buffer/set-name.md) | 设置资源名称 | ## 相关文档 diff --git a/docs/api/rhi/opengl/command-list/command-list.md b/docs/api/rhi/opengl/command-list/command-list.md index 26ac4259..56f82432 100644 --- a/docs/api/rhi/opengl/command-list/command-list.md +++ b/docs/api/rhi/opengl/command-list/command-list.md @@ -4,40 +4,39 @@ **描述**: OpenGL 命令列表实现，继承自 `RHICommandList`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](../../command-list/shutdown.md) | -| `Reset` | [详细文档](../../command-list/reset.md) | -| `Close` | [详细文档](../../command-list/close.md) | -| `Clear` | [详细文档](clear.md) | -| `ClearColor` | [详细文档](clear-color.md) | -| `ClearDepth` | [详细文档](clear-depth.md) | -| `ClearStencil` | [详细文档](clear-stencil.md) | -| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) | -| `SetPipelineState` | [详细文档](set-pipeline-state.md) | -| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) | -| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) | -| `SetIndexBuffer` | [详细文档](set-index-buffer.md) | -| `TransitionBarrier` | [详细文档](transition-barrier.md) | -| `SetPrimitiveTopology` | [详细文档](set-primitive-topology.md) | -| `SetViewport` | [详细文档](set-viewport.md) | -| `SetViewports` | [详细文档](set-viewports.md) | -| `SetScissorRect` | [详细文档](set-scissor-rect.md) | -| `SetScissorRects` | [详细文档](set-scissor-rects.md) | -| `SetRenderTargets` | [详细文档](set-render-targets.md) | -| `SetDepthStencilState` | [详细文档](set-depth-stencil-state.md) | -| `SetStencilRef` | [详细文档](set-stencil-ref.md) | -| `SetBlendState` | [详细文档](set-blend-state.md) | -| `SetBlendFactor` | [详细文档](set-blend-factor.md) | -| `ClearRenderTarget` | [详细文档](clear-render-target.md) | -| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) | -| `Draw` | [详细文档](draw.md) | -| `DrawIndexed` | [详细文档](draw-indexed.md) | -| `Dispatch` | [详细文档](dispatch.md) | -| `CopyResource` | [详细文档](copy-resource.md) | -| **OpenGL 特有方法** | [详细文档](opengl-methods.md) | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令列表 | +| [`Reset`](../../command-list/reset.md) | 重置命令列表 | +| [`Close`](../../command-list/close.md) | 关闭命令列表 | +| [`Clear`](clear.md) | 清除 | +| [`ClearColor`](clear-color.md) | 清除颜色 | +| [`ClearDepth`](clear-depth.md) | 清除深度 | +| [`ClearStencil`](clear-stencil.md) | 清除模板 | +| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 | +| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 | +| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 | +| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 | +| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 | +| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 | +| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 | +| [`SetViewport`](set-viewport.md) | 设置视口 | +| [`SetViewports`](set-viewports.md) | 设置多个视口 | +| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 | +| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 | +| [`SetRenderTargets`](set-render-targets.md) | 设置渲染目标 | +| [`SetDepthStencilState`](set-depth-stencil-state.md) | 设置深度模板状态 | +| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 | +| [`SetBlendState`](set-blend-state.md) | 设置混合状态 | +| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 | +| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 | +| [`Draw`](draw.md) | 绘制 | +| [`DrawIndexed`](draw-indexed.md) | 索引绘制 | +| [`Dispatch`](dispatch.md) | 分发计算任务 | +| [`CopyResource`](copy-resource.md) | 复制资源 | +| [`OpenGLMethods`](opengl-methods.md) | OpenGL 特有方法 | ## 相关文档 diff --git a/docs/api/rhi/opengl/command-queue/command-queue.md b/docs/api/rhi/opengl/command-queue/command-queue.md index c93f1274..2c5f6718 100644 --- a/docs/api/rhi/opengl/command-queue/command-queue.md +++ b/docs/api/rhi/opengl/command-queue/command-queue.md @@ -4,19 +4,19 @@ **描述**: OpenGL 命令队列实现，继承自 `RHICommandQueue`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](../../command-queue/shutdown.md) | -| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) | -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](../../../threading/task-group/wait.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `WaitForIdle` | [详细文档](wait-for-idle.md) | -| `GetType` | [详细文档](../../command-queue/get-type.md) | -| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) | -| `GetNativeHandle` | [详细文档](../../command-queue/get-native-handle.md) | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令队列 | +| [`ExecuteCommandLists`](execute-command-lists.md) | 执行命令列表 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`WaitForIdle`](wait-for-idle.md) | 等待空闲 | +| [`GetType`](../../command-queue/get-type.md) | 获取队列类型 | +| [`GetTimestampFrequency`](get-timestamp-frequency.md) | 获取时间戳频率 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md b/docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md index e893290d..7f5c5e74 100644 --- a/docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md +++ b/docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md @@ -4,24 +4,25 @@ **描述**: OpenGL 深度模板视图实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `InitializeCubemap` | [详细文档](initialize-cubemap.md) | -| `Shutdown` | [详细文档](shutdown.md) | -| `Bind` | [详细文档](bind.md) | -| `Unbind` | [详细文档](unbind.md) | -| `ClearDepth` | [详细文档](clear-depth.md) | -| `ClearStencil` | [详细文档](clear-stencil.md) | -| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) | -| `GetFramebuffer` | [详细文档](get-framebuffer.md) | -| `GetTexture` | [详细文档](get-texture.md) | -| `GetMipLevel` | [详细文档](get-mip-level.md) | -| `GetWidth` / `GetHeight` | [详细文档](get-size.md) | -| `BindFramebuffer` | [详细文档](bind-framebuffer.md) | -| `UnbindFramebuffer` | [详细文档](unbind-framebuffer.md) | +| [`Initialize`](initialize.md) | 初始化深度模板视图 | +| [`InitializeCubemap`](initialize-cubemap.md) | 初始化立方体贴图深度模板视图 | +| [`Shutdown`](shutdown.md) | 关闭深度模板视图 | +| [`Bind`](bind.md) | 绑定深度模板视图 | +| [`Unbind`](unbind.md) | 解绑深度模板视图 | +| [`ClearDepth`](clear-depth.md) | 清除深度 | +| [`ClearStencil`](clear-stencil.md) | 清除模板 | +| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度和模板 | +| [`GetFramebuffer`](get-framebuffer.md) | 获取帧缓冲 | +| [`GetTexture`](get-texture.md) | 获取纹理 | +| [`GetMipLevel`](get-mip-level.md) | 获取 Mip 级别 | +| [`GetWidth`](get-size.md) | 获取宽度 | +| [`GetHeight`](get-size.md) | 获取高度 | +| [`BindFramebuffer`](bind-framebuffer.md) | 绑定帧缓冲 | +| [`UnbindFramebuffer`](unbind-framebuffer.md) | 解绑帧缓冲 | ## 相关文档 diff --git a/docs/api/rhi/opengl/device/device.md b/docs/api/rhi/opengl/device/device.md index ea369ff5..c63ade7d 100644 --- a/docs/api/rhi/opengl/device/device.md +++ b/docs/api/rhi/opengl/device/device.md @@ -4,32 +4,32 @@ **描述**: OpenGL 设备的实现，继承自 `RHIDevice`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](../../device/initialize.md) | -| `Shutdown` | [详细文档](../../device/shutdown.md) | -| `CreateRenderWindow` | [详细文档](create-render-window.md) | -| `InitializeWithExistingWindow` | [详细文档](initialize-with-existing-window.md) | -| `GetWindow` | [详细文档](get-window.md) | -| `SwapBuffers` | [详细文档](swap-buffers.md) | -| `PollEvents` | [详细文档](poll-events.md) | -| `SetShouldClose` | [详细文档](set-should-close.md) | -| `ShouldClose` | [详细文档](should-close.md) | -| `CreateBuffer` | [详细文档](../../device/create-buffer.md) | -| `CreateTexture` | [详细文档](../../device/create-texture.md) | -| `CreateSwapChain` | [详细文档](../../device/create-swap-chain.md) | -| `CreateCommandList` | [详细文档](../../device/create-command-list.md) | -| `CreateCommandQueue` | [详细文档](../../device/create-command-queue.md) | -| `CompileShader` | [详细文档](../../device/compile-shader.md) | -| `CreatePipelineState` | [详细文档](../../device/create-pipeline-state.md) | -| `CreateFence` | [详细文档](../../device/create-fence.md) | -| `CreateSampler` | [详细文档](../../device/create-sampler.md) | -| `GetCapabilities` | [详细文档](../../device/get-capabilities.md) | -| `GetDeviceInfo` | [详细文档](../../device/get-device-info.md) | -| `GetNativeDevice` | [详细文档](../../device/get-native-device.md) | -| `GetNativeHandle` | [详细文档](../../device/get-native-device.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化设备 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭设备 | +| [`CreateRenderWindow`](create-render-window.md) | 创建渲染窗口 | +| [`InitializeWithExistingWindow`](initialize-with-existing-window.md) | 使用现有窗口初始化 | +| [`GetWindow`](get-window.md) | 获取窗口 | +| [`SwapBuffers`](swap-buffers.md) | 交换缓冲 | +| [`PollEvents`](poll-events.md) | 处理窗口事件 | +| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 | +| [`ShouldClose`](should-close.md) | 检查是否应关闭 | +| [`CreateBuffer`](../../device/create-buffer.md) | 创建缓冲区 | +| [`CreateTexture`](../../device/create-texture.md) | 创建纹理 | +| [`CreateSwapChain`](../../device/create-swap-chain.md) | 创建交换链 | +| [`CreateCommandList`](../../device/create-command-list.md) | 创建命令列表 | +| [`CreateCommandQueue`](../../device/create-command-queue.md) | 创建命令队列 | +| [`CompileShader`](../../device/compile-shader.md) | 编译着色器 | +| [`CreatePipelineState`](../../device/create-pipeline-state.md) | 创建管线状态 | +| [`CreateFence`](../../device/create-fence.md) | 创建栅栏 | +| [`CreateSampler`](../../device/create-sampler.md) | 创建采样器 | +| [`GetCapabilities`](../../device/get-capabilities.md) | 获取设备能力 | +| [`GetDeviceInfo`](../../device/get-device-info.md) | 获取设备信息 | +| [`GetNativeDevice`](../../device/get-native-device.md) | 获取原生设备 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/opengl/fence/fence.md b/docs/api/rhi/opengl/fence/fence.md index bbd888cb..4a50e3d1 100644 --- a/docs/api/rhi/opengl/fence/fence.md +++ b/docs/api/rhi/opengl/fence/fence.md @@ -4,20 +4,20 @@ **描述**: OpenGL 栅栏同步实现，继承自 `RHIFence`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `Shutdown` | [详细文档](../../fence/shutdown.md) | -| `Signal` | [详细文档](signal.md) | -| `Wait` | [详细文档](../../../threading/task-group/wait.md) | -| `Reset` | [详细文档](reset.md) | -| `IsSignaled` | [详细文档](is-signaled.md) | -| `GetStatus` | [详细文档](get-status.md) | -| `GetCompletedValue` | [详细文档](get-completed-value.md) | -| `GetCurrentValue` | [详细文档](get-current-value.md) | -| `GetNativeHandle` | [详细文档](../../fence/get-native-handle.md) | +| [`Initialize`](initialize.md) | 初始化栅栏 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭栅栏 | +| [`Signal`](signal.md) | 信号栅栏 | +| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 | +| [`Reset`](reset.md) | 重置栅栏 | +| [`IsSignaled`](is-signaled.md) | 检查是否已信号 | +| [`GetStatus`](get-status.md) | 获取状态 | +| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 | +| [`GetCurrentValue`](get-current-value.md) | 获取当前值 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/opengl/pipeline-state/pipeline-state.md b/docs/api/rhi/opengl/pipeline-state/pipeline-state.md index 96e32a48..9b853bd3 100644 --- a/docs/api/rhi/opengl/pipeline-state/pipeline-state.md +++ b/docs/api/rhi/opengl/pipeline-state/pipeline-state.md @@ -4,34 +4,34 @@ **描述**: OpenGL 管线状态对象实现，继承自 `RHIPipelineState`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](../../pipeline-state/shutdown.md) | -| `Bind` | [详细文档](../../shader/bind.md) | -| `Unbind` | [详细文档](../../shader/unbind.md) | -| `GetNativeHandle` | [详细文档](../../pipeline-state/get-native-handle.md) | -| `GetType` | [详细文档](../../pipeline-state/get-type.md) | -| `SetDepthStencilState` | [详细文档](set-depth-stencil-state.md) | -| `SetBlendState` | [详细文档](set-blend-state.md) | -| `SetRasterizerState` | [详细文档](set-rasterizer-state.md) | -| `SetViewport` | [详细文档](set-viewport.md) | -| `SetScissor` | [详细文档](set-scissor.md) | -| `SetLogicalOperation` | [详细文档](set-logical-operation.md) | -| `Apply` | [详细文档](apply.md) | -| `ApplyDepthStencil` | [详细文档](apply-depth-stencil.md) | -| `ApplyBlend` | [详细文档](apply-blend.md) | -| `ApplyRasterizer` | [详细文档](apply-rasterizer.md) | -| `ApplyViewport` | [详细文档](apply-viewport.md) | -| `ApplyScissor` | [详细文档](apply-scissor.md) | -| `SetClearColor` | [详细文档](set-clear-color.md) | -| `Clear` | [详细文档](../../command-list/clear.md) | -| `AttachShader` | [详细文档](attach-shader.md) | -| `DetachShader` | [详细文档](detach-shader.md) | -| `GetDepthStencilState` | [详细文档](get-depth-stencil-state.md) | -| `GetBlendState` | [详细文档](get-blend-state.md) | -| `GetRasterizerState` | [详细文档](get-rasterizer-state.md) | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭管线状态 | +| [`Bind`](../../shader/bind.md) | 绑定管线状态 | +| [`Unbind`](../../shader/unbind.md) | 解绑管线状态 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetType`](../../command-queue/get-type.md) | 获取管线类型 | +| [`SetDepthStencilState`](set-depth-stencil-state.md) | 设置深度模板状态 | +| [`SetBlendState`](set-blend-state.md) | 设置混合状态 | +| [`SetRasterizerState`](set-rasterizer-state.md) | 设置光栅化状态 | +| [`SetViewport`](set-viewport.md) | 设置视口 | +| [`SetScissor`](set-scissor.md) | 设置裁剪 | +| [`SetLogicalOperation`](set-logical-operation.md) | 设置逻辑操作 | +| [`Apply`](apply.md) | 应用管线状态 | +| [`ApplyDepthStencil`](apply-depth-stencil.md) | 应用深度模板状态 | +| [`ApplyBlend`](apply-blend.md) | 应用混合状态 | +| [`ApplyRasterizer`](apply-rasterizer.md) | 应用光栅化状态 | +| [`ApplyViewport`](apply-viewport.md) | 应用视口 | +| [`ApplyScissor`](apply-scissor.md) | 应用裁剪 | +| [`SetClearColor`](set-clear-color.md) | 设置清除颜色 | +| [`Clear`](../../command-list/clear.md) | 清除 | +| [`AttachShader`](attach-shader.md) | 附加着色器 | +| [`DetachShader`](detach-shader.md) | 分离着色器 | +| [`GetDepthStencilState`](get-depth-stencil-state.md) | 获取深度模板状态 | +| [`GetBlendState`](get-blend-state.md) | 获取混合状态 | +| [`GetRasterizerState`](get-rasterizer-state.md) | 获取光栅化状态 | ## 相关文档 diff --git a/docs/api/rhi/opengl/render-target-view/render-target-view.md b/docs/api/rhi/opengl/render-target-view/render-target-view.md index efcd9c56..5d071bb2 100644 --- a/docs/api/rhi/opengl/render-target-view/render-target-view.md +++ b/docs/api/rhi/opengl/render-target-view/render-target-view.md @@ -4,22 +4,23 @@ **描述**: OpenGL 渲染目标视图实现。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `InitializeCubemap` | [详细文档](initialize-cubemap.md) | -| `Shutdown` | [详细文档](shutdown.md) | -| `Bind` | [详细文档](bind.md) | -| `Unbind` | [详细文档](unbind.md) | -| `Clear` | [详细文档](clear.md) | -| `GetFramebuffer` | [详细文档](get-framebuffer.md) | -| `GetTexture` | [详细文档](get-texture.md) | -| `GetMipLevel` | [详细文档](get-mip-level.md) | -| `GetWidth` / `GetHeight` | [详细文档](get-size.md) | -| `BindFramebuffer` | [详细文档](bind-framebuffer.md) | -| `UnbindFramebuffer` | [详细文档](unbind-framebuffer.md) | +| [`Initialize`](initialize.md) | 初始化渲染目标视图 | +| [`InitializeCubemap`](initialize-cubemap.md) | 初始化立方体贴图渲染目标视图 | +| [`Shutdown`](shutdown.md) | 关闭渲染目标视图 | +| [`Bind`](bind.md) | 绑定渲染目标视图 | +| [`Unbind`](unbind.md) | 解绑渲染目标视图 | +| [`Clear`](clear.md) | 清除 | +| [`GetFramebuffer`](get-framebuffer.md) | 获取帧缓冲 | +| [`GetTexture`](get-texture.md) | 获取纹理 | +| [`GetMipLevel`](get-mip-level.md) | 获取 Mip 级别 | +| [`GetWidth`](get-size.md) | 获取宽度 | +| [`GetHeight`](get-size.md) | 获取高度 | +| [`BindFramebuffer`](bind-framebuffer.md) | 绑定帧缓冲 | +| [`UnbindFramebuffer`](unbind-framebuffer.md) | 解绑帧缓冲 | ## 相关文档 diff --git a/docs/api/rhi/opengl/sampler/sampler.md b/docs/api/rhi/opengl/sampler/sampler.md index 04238299..e90b9cbe 100644 --- a/docs/api/rhi/opengl/sampler/sampler.md +++ b/docs/api/rhi/opengl/sampler/sampler.md @@ -4,16 +4,16 @@ **描述**: OpenGL 采样器实现，继承自 `RHISampler`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `Shutdown` | [详细文档](../../sampler/shutdown.md) | -| `Bind` | [详细文档](bind.md) | -| `Unbind` | [详细文档](unbind.md) | -| `GetID` | [详细文档](get-id.md) | -| `GetNativeHandle` | [详细文档](../../sampler/get-native-handle.md) | +| [`Initialize`](initialize.md) | 初始化采样器 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭采样器 | +| [`Bind`](bind.md) | 绑定采样器 | +| [`Unbind`](unbind.md) | 解绑采样器 | +| [`GetID`](get-id.md) | 获取采样器 ID | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/opengl/shader/shader.md b/docs/api/rhi/opengl/shader/shader.md index 4df31e9d..0e2dd213 100644 --- a/docs/api/rhi/opengl/shader/shader.md +++ b/docs/api/rhi/opengl/shader/shader.md @@ -4,28 +4,28 @@ **描述**: OpenGL 着色器实现，继承自 `RHIShader`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `CompileFromFile` | [详细文档](../../shader/compile-from-file.md) | -| `Compile` | [详细文档](../../shader/compile.md) | -| `Shutdown` | [详细文档](../../shader/shutdown.md) | -| `Use` | [详细文档](use.md) | -| `Bind` | [详细文档](../../shader/bind.md) | -| `Unbind` | [详细文档](../../shader/unbind.md) | -| `SetInt` | [详细文档](../../shader/set-int.md) | -| `SetIntArray` | [详细文档](set-int-array.md) | -| `SetFloat` | [详细文档](../../shader/set-float.md) | -| `SetFloatArray` | [详细文档](set-float-array.md) | -| `SetVec3` | [详细文档](../../shader/set-vec3.md) | -| `SetVec4` | [详细文档](../../shader/set-vec4.md) | -| `SetMat4` | [详细文档](../../shader/set-mat4.md) | -| `GetUniformLocation` | [详细文档](get-uniform-location.md) | -| `GetID` | [详细文档](get-id.md) | -| `GetNativeHandle` | [详细文档](../../shader/get-native-handle.md) | -| `IsValid` | [详细文档](../../shader/is-valid.md) | -| `GetType` | [详细文档](../../shader/get-type.md) | +| [`CompileFromFile`](../../shader/compile-from-file.md) | 从文件编译着色器 | +| [`Compile`](../../shader/compile.md) | 从源码编译着色器 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭着色器 | +| [`Use`](use.md) | 使用着色器 | +| [`Bind`](../../shader/bind.md) | 绑定着色器 | +| [`Unbind`](../../shader/unbind.md) | 解绑着色器 | +| [`SetInt`](../../shader/set-int.md) | 设置整数 uniform | +| [`SetIntArray`](set-int-array.md) | 设置整数数组 uniform | +| [`SetFloat`](../../shader/set-float.md) | 设置浮点数 uniform | +| [`SetFloatArray`](set-float-array.md) | 设置浮点数数组 uniform | +| [`SetVec3`](../../shader/set-vec3.md) | 设置 vec3 uniform | +| [`SetVec4`](../../shader/set-vec4.md) | 设置 vec4 uniform | +| [`SetMat4`](../../shader/set-mat4.md) | 设置 mat4 uniform | +| [`GetUniformLocation`](get-uniform-location.md) | 获取 uniform 位置 | +| [`GetID`](get-id.md) | 获取着色器 ID | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`IsValid`](../../shader/is-valid.md) | 检查是否有效 | +| [`GetType`](../../command-queue/get-type.md) | 获取着色器类型 | ## 相关文档 diff --git a/docs/api/rhi/opengl/swap-chain/swap-chain.md b/docs/api/rhi/opengl/swap-chain/swap-chain.md index cd499002..7ced78ce 100644 --- a/docs/api/rhi/opengl/swap-chain/swap-chain.md +++ b/docs/api/rhi/opengl/swap-chain/swap-chain.md @@ -4,29 +4,31 @@ **描述**: OpenGL 交换链实现，继承自 `RHISwapChain`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` (vsync) | [详细文档](initialize.md) | -| `Initialize` (mode) | [详细文档](initialize-mode.md) | -| `Shutdown` | [详细文档](../../swap-chain/shutdown.md) | -| `Present` | [详细文档](present.md) | -| `SwapBuffers` | [详细文档](swap-buffers.md) | -| `Resize` | [详细文档](../../swap-chain/swap-chain.md) | -| `SetVSync` | [详细文档](set-vsync.md) | -| `IsVSync` | [详细文档](is-vsync.md) | -| `SetFullscreen` | [详细文档](set-fullscreen.md) | -| `IsFullscreen` | [详细文档](is-fullscreen.md) | -| `ShouldClose` | [详细文档](should-close.md) | -| `SetShouldClose` | [详细文档](set-should-close.md) | -| `PollEvents` | [详细文档](poll-events.md) | -| `GetCurrentBackBufferIndex` | [详细文档](../../swap-chain/get-current-back-buffer-index.md) | -| `GetCurrentBackBuffer` | [详细文档](../../swap-chain/get-current-back-buffer.md) | -| `GetWidth` / `GetHeight` | [详细文档](get-size.md) | -| `GetFramebufferWidth` / `GetFramebufferHeight` | [详细文档](get-framebuffer-size.md) | -| `GetWindow` | [详细文档](get-window.md) | -| `GetNativeHandle` | [详细文档](../../swap-chain/get-native-handle.md) | +| [`Initialize`](initialize.md) | 初始化交换链 | +| [`InitializeMode`](initialize-mode.md) | 使用模式初始化 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭交换链 | +| [`Present`](present.md) | 呈现画面 | +| [`SwapBuffers`](swap-buffers.md) | 交换缓冲 | +| [`Resize`](../../swap-chain/resize.md) | 调整交换链大小 | +| [`SetVSync`](set-vsync.md) | 设置垂直同步 | +| [`IsVSync`](is-vsync.md) | 检查是否垂直同步 | +| [`SetFullscreen`](set-fullscreen.md) | 设置全屏模式 | +| [`IsFullscreen`](is-fullscreen.md) | 检查是否全屏 | +| [`ShouldClose`](should-close.md) | 检查是否应关闭 | +| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 | +| [`PollEvents`](poll-events.md) | 处理窗口事件 | +| [`GetCurrentBackBufferIndex`](../../swap-chain/get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 | +| [`GetCurrentBackBuffer`](../../swap-chain/get-current-back-buffer.md) | 获取当前后台缓冲区 | +| [`GetWidth`](get-size.md) | 获取宽度 | +| [`GetHeight`](get-size.md) | 获取高度 | +| [`GetFramebufferWidth`](get-framebuffer-size.md) | 获取帧缓冲宽度 | +| [`GetFramebufferHeight`](get-framebuffer-size.md) | 获取帧缓冲高度 | +| [`GetWindow`](get-window.md) | 获取窗口 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/opengl/texture/texture.md b/docs/api/rhi/opengl/texture/texture.md index 7c2482d3..597946b6 100644 --- a/docs/api/rhi/opengl/texture/texture.md +++ b/docs/api/rhi/opengl/texture/texture.md @@ -4,34 +4,34 @@ **描述**: OpenGL 纹理的实现，继承自 `RHITexture`。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize-2d.md) | -| `Initialize2D` | [详细文档](initialize-2d.md) | -| `InitializeCubeMap` | [详细文档](initialize-cube-map.md) | -| `LoadFromFile` | [详细文档](load-from-file.md) | -| `Shutdown` | [详细文档](../../texture/shutdown.md) | -| `Bind` | [详细文档](bind-image.md) | -| `Unbind` | [详细文档](../../shader/unbind.md) | -| `BindImage` | [详细文档](bind-image.md) | -| `GenerateMipmap` | [详细文档](generate-mipmap.md) | -| `SetFiltering` | [详细文档](set-filtering.md) | -| `SetWrapping` | [详细文档](set-wrapping.md) | -| `GetID` | [详细文档](get-id.md) | -| `GetOpenGLType` | [详细文档](get-opengl-type.md) | -| `GetWidth` | [详细文档](../../texture/get-width.md) | -| `GetHeight` | [详细文档](../../texture/get-height.md) | -| `GetDepth` | [详细文档](../../texture/get-depth.md) | -| `GetMipLevels` | [详细文档](../../texture/get-mip-levels.md) | -| `GetTextureType` | [详细文档](../../texture/get-texture-type.md) | -| `GetNativeHandle` | [详细文档](../../texture/get-native-handle.md) | -| `GetState` | [详细文档](../../texture/get-state.md) | -| `SetState` | [详细文档](../../texture/set-state.md) | -| `GetName` | [详细文档](../../texture/get-name.md) | -| `SetName` | [详细文档](../../texture/set-name.md) | -| `GetFormat` | [详细文档](../../texture/get-format.md) | +| [`Initialize`](initialize-2d.md) | 初始化 2D 纹理 | +| [`Initialize2D`](initialize-2d.md) | 初始化 2D 纹理 | +| [`InitializeCubeMap`](initialize-cube-map.md) | 初始化立方体贴图 | +| [`LoadFromFile`](load-from-file.md) | 从文件加载纹理 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭纹理 | +| [`Bind`](bind-image.md) | 绑定纹理 | +| [`Unbind`](../../shader/unbind.md) | 解绑纹理 | +| [`BindImage`](bind-image.md) | 绑定图像 | +| [`GenerateMipmap`](generate-mipmap.md) | 生成多级渐远纹理 | +| [`SetFiltering`](set-filtering.md) | 设置过滤模式 | +| [`SetWrapping`](set-wrapping.md) | 设置环绕模式 | +| [`GetID`](get-id.md) | 获取 OpenGL 纹理 ID | +| [`GetOpenGLType`](get-opengl-type.md) | 获取 OpenGL 纹理类型 | +| [`GetWidth`](../../texture/get-width.md) | 获取纹理宽度 | +| [`GetHeight`](../../texture/get-height.md) | 获取纹理高度 | +| [`GetDepth`](../../texture/get-depth.md) | 获取纹理深度 | +| [`GetMipLevels`](../../texture/get-mip-levels.md) | 获取 Mip 级别 | +| [`GetTextureType`](../../texture/get-texture-type.md) | 获取纹理类型 | +| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 | +| [`GetState`](../../buffer/get-state.md) | 获取资源状态 | +| [`SetState`](../../buffer/set-state.md) | 设置资源状态 | +| [`GetName`](../../buffer/get-name.md) | 获取资源名称 | +| [`SetName`](../../buffer/set-name.md) | 设置资源名称 | +| [`GetFormat`](../../texture/get-format.md) | 获取纹理格式 | ## 相关文档 diff --git a/docs/api/rhi/opengl/vertex-array/vertex-array.md b/docs/api/rhi/opengl/vertex-array/vertex-array.md index 2431b16b..ecbcbce6 100644 --- a/docs/api/rhi/opengl/vertex-array/vertex-array.md +++ b/docs/api/rhi/opengl/vertex-array/vertex-array.md @@ -4,19 +4,19 @@ **描述**: OpenGL 顶点数组对象 (VAO) 封装。 -## 方法列表 +## 公共方法 -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](add-vertex-buffer.md) | -| `AddVertexBuffer` | [详细文档](add-vertex-buffer.md) | -| `SetIndexBuffer` | [详细文档](set-index-buffer.md) | -| `Shutdown` | [详细文档](get-id.md) | -| `Bind` | [详细文档](../../shader/bind.md) | -| `Unbind` | [详细文档](../../shader/unbind.md) | -| `GetID` | [详细文档](get-id.md) | -| `GetIndexBuffer` | [详细文档](get-index-buffer.md) | -| `GetIndexCount` | [详细文档](get-index-count.md) | +| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化顶点数组 | +| [`AddVertexBuffer`](add-vertex-buffer.md) | 添加顶点缓冲 | +| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 | +| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭顶点数组 | +| [`Bind`](../../shader/bind.md) | 绑定顶点数组 | +| [`Unbind`](../../shader/unbind.md) | 解绑顶点数组 | +| [`GetID`](get-id.md) | 获取 OpenGL VAO ID | +| [`GetIndexBuffer`](get-index-buffer.md) | 获取索引缓冲 | +| [`GetIndexCount`](get-index-count.md) | 获取索引数量 | ## 相关文档 diff --git a/docs/api/rhi/pipeline-layout/pipeline-layout.md b/docs/api/rhi/pipeline-layout/pipeline-layout.md index 24f91427..44195303 100644 --- a/docs/api/rhi/pipeline-layout/pipeline-layout.md +++ b/docs/api/rhi/pipeline-layout/pipeline-layout.md @@ -8,18 +8,11 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Initialize` | [详细文档](initialize.md) | -| `Shutdown` | [详细文档](shutdown.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`Initialize`](initialize.md) | 初始化管线布局 | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 相关文档 diff --git a/docs/api/rhi/pipeline-state/pipeline-state.md b/docs/api/rhi/pipeline-state/pipeline-state.md index bcfd306c..4abd8da0 100644 --- a/docs/api/rhi/pipeline-state/pipeline-state.md +++ b/docs/api/rhi/pipeline-state/pipeline-state.md @@ -8,25 +8,13 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 绑定/解绑 - -| 方法 | 文档 | -|------|------| -| `Bind` | [详细文档](methods.md) | -| `Unbind` | [详细文档](methods.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | -| `GetType` | [详细文档](get-type.md) | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`Bind`](../shader/bind.md) | 绑定管线状态 | +| [`Unbind`](../shader/unbind.md) | 解绑管线状态 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | +| [`GetType`](get-type.md) | 获取管线类型 | ## 管线类型 (PipelineType) diff --git a/docs/api/rhi/rhi.md b/docs/api/rhi/rhi.md index 742a1ebb..b667787f 100644 --- a/docs/api/rhi/rhi.md +++ b/docs/api/rhi/rhi.md @@ -113,7 +113,7 @@ delete device; ## 后端文档 -- [D3D12 后端](d3d12/overview.md) - DirectX 12 实现详情 +- [D3D12 后端](opengl/overview.md) - DirectX 12 实现详情 - [OpenGL 后端](opengl/overview.md) - OpenGL 实现详情 ## 相关文档 diff --git a/docs/api/rhi/sampler/sampler.md b/docs/api/rhi/sampler/sampler.md index 043a061b..67224046 100644 --- a/docs/api/rhi/sampler/sampler.md +++ b/docs/api/rhi/sampler/sampler.md @@ -8,25 +8,13 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 绑定/解绑 - -| 方法 | 文档 | -|------|------| -| `Bind` | [详细文档](methods.md) | -| `Unbind` | [详细文档](methods.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | -| `GetID` | [详细文档](get-id.md) | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`Bind`](../shader/bind.md) | 绑定采样器 | +| [`Unbind`](../shader/unbind.md) | 解绑采样器 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | +| [`GetID`](get-id.md) | 获取采样器 ID | ## 相关文档 diff --git a/docs/api/rhi/shader/shader.md b/docs/api/rhi/shader/shader.md index c1bd9046..89932473 100644 --- a/docs/api/rhi/shader/shader.md +++ b/docs/api/rhi/shader/shader.md @@ -8,48 +8,21 @@ ## 公共方法 -### 编译 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `CompileFromFile` | [详细文档](compile-from-file.md) | -| `Compile` | [详细文档](compile.md) | - -### 属性访问 - -| 方法 | 文档 | -|------|------| -| `GetType` | [详细文档](get-type.md) | -| `IsValid` | [详细文档](is-valid.md) | - -### 绑定/解绑 - -| 方法 | 文档 | -|------|------| -| `Bind` | [详细文档](bind.md) | -| `Unbind` | [详细文档](unbind.md) | - -### Uniform 设置 - -| 方法 | 文档 | -|------|------| -| `SetInt` | [详细文档](set-int.md) | -| `SetFloat` | [详细文档](set-float.md) | -| `SetVec3` | [详细文档](set-vec3.md) | -| `SetVec4` | [详细文档](set-vec4.md) | -| `SetMat4` | [详细文档](set-mat4.md) | - -### 生命周期 - -| 方法 | 文档 | -|------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`CompileFromFile`](compile-from-file.md) | 从文件编译着色器 | +| [`Compile`](compile.md) | 从源码编译着色器 | +| [`GetType`](get-type.md) | 获取着色器类型 | +| [`IsValid`](is-valid.md) | 检查着色器是否有效 | +| [`Bind`](bind.md) | 绑定着色器 | +| [`Unbind`](unbind.md) | 解绑着色器 | +| [`SetInt`](set-int.md) | 设置整数 uniform | +| [`SetFloat`](set-float.md) | 设置浮点数 uniform | +| [`SetVec3`](set-vec3.md) | 设置 vec3 uniform | +| [`SetVec4`](set-vec4.md) | 设置 vec4 uniform | +| [`SetMat4`](set-mat4.md) | 设置 mat4 uniform | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 着色器类型 (ShaderType) diff --git a/docs/api/rhi/swap-chain/swap-chain.md b/docs/api/rhi/swap-chain/swap-chain.md index acb4a8a3..9deaa4df 100644 --- a/docs/api/rhi/swap-chain/swap-chain.md +++ b/docs/api/rhi/swap-chain/swap-chain.md @@ -8,41 +8,19 @@ ## 公共方法 -### 生命周期 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 交换链操作 - -| 方法 | 文档 | -|------|------| -| `GetCurrentBackBufferIndex` | [详细文档](get-current-back-buffer-index.md) | -| `GetCurrentBackBuffer` | [详细文档](get-current-back-buffer.md) | -| `Present` | [详细文档](present.md) | -| `Resize` | [详细文档](methods.md) | - -### 全屏模式 - -| 方法 | 文档 | -|------|------| -| `SetFullscreen` | [详细文档](set-fullscreen.md) | -| `IsFullscreen` | [详细文档](is-fullscreen.md) | - -### 窗口事件 - -| 方法 | 文档 | -|------|------| -| `ShouldClose` | [详细文档](should-close.md) | -| `SetShouldClose` | [详细文档](set-should-close.md) | -| `PollEvents` | [详细文档](poll-events.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`GetCurrentBackBufferIndex`](get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 | +| [`GetCurrentBackBuffer`](get-current-back-buffer.md) | 获取当前后台缓冲区 | +| [`Present`](present.md) | 呈现画面 | +| [`Resize`](resize.md) | 调整交换链大小 | +| [`SetFullscreen`](set-fullscreen.md) | 设置全屏模式 | +| [`IsFullscreen`](is-fullscreen.md) | 检查是否全屏 | +| [`ShouldClose`](should-close.md) | 检查是否应关闭 | +| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 | +| [`PollEvents`](poll-events.md) | 处理窗口事件 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | ## 使用示例 diff --git a/docs/api/rhi/texture/texture.md b/docs/api/rhi/texture/texture.md index fe6c94ab..2b27912e 100644 --- a/docs/api/rhi/texture/texture.md +++ b/docs/api/rhi/texture/texture.md @@ -8,37 +8,20 @@ ## 公共方法 -### 属性访问 - -| 方法 | 文档 | +| 方法 | 描述 | |------|------| -| `GetWidth` | [详细文档](get-width.md) | -| `GetHeight` | [详细文档](get-height.md) | -| `GetDepth` | [详细文档](get-depth.md) | -| `GetMipLevels` | [详细文档](get-mip-levels.md) | -| `GetFormat` | [详细文档](get-format.md) | -| `GetTextureType` | [详细文档](get-texture-type.md) | - -### 状态管理 - -| 方法 | 文档 | -|------|------| -| `GetState` | [详细文档](get-state.md) | -| `SetState` | [详细文档](set-state.md) | - -### 生命周期 - -| 方法 | 文档 | -|------|------| -| `Shutdown` | [详细文档](shutdown.md) | - -### 其他 - -| 方法 | 文档 | -|------|------| -| `GetNativeHandle` | [详细文档](get-native-handle.md) | -| `GetName` | [详细文档](get-name.md) | -| `SetName` | [详细文档](set-name.md) | +| [`GetWidth`](get-width.md) | 获取纹理宽度 | +| [`GetHeight`](get-height.md) | 获取纹理高度 | +| [`GetDepth`](get-depth.md) | 获取纹理深度 | +| [`GetMipLevels`](get-mip-levels.md) | 获取 Mip 级别数量 | +| [`GetFormat`](get-format.md) | 获取纹理格式 | +| [`GetTextureType`](get-texture-type.md) | 获取纹理类型 | +| [`GetState`](get-state.md) | 获取资源状态 | +| [`SetState`](set-state.md) | 设置资源状态 | +| [`Shutdown`](shutdown.md) | 关闭并释放资源 | +| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 | +| [`GetName`](get-name.md) | 获取资源名称 | +| [`SetName`](set-name.md) | 设置资源名称 | ## 纹理类型 (TextureType) diff --git a/docs/api/threading/task-system/task-system.md b/docs/api/threading/task-system/task-system.md index 92e1a831..dc40ef78 100644 --- a/docs/api/threading/task-system/task-system.md +++ b/docs/api/threading/task-system/task-system.md @@ -22,50 +22,18 @@ ## 公共方法 -### 生命周期 - | 方法 | 描述 | |------|------| | [`Get`](get.md) | 获取单例实例 | | [`Initialize`](initialize.md) | 初始化任务系统 | | [`Shutdown`](shutdown.md) | 关闭任务系统 | - -### 任务提交 - -| 方法 | 描述 | -|------|------| | [`Submit(unique_ptr)`](submit.md) | 提交任务对象 | | [`Submit(callback)`](submit.md) | 提交 lambda 任务 | - -### 任务组 - -| 方法 | 描述 | -|------|------| | [`CreateTaskGroup`](createtaskgroup.md) | 创建任务组 | | [`DestroyTaskGroup`](destroytaskgroup.md) | 销毁任务组 | - -### 等待 - -| 方法 | 描述 | -|------|------| | [`Wait`](wait.md) | 等待指定任务完成（当前为空实现） | - -### 信息 - -| 方法 | 描述 | -|------|------| | [`GetWorkerThreadCount`](getworkerthreadcount.md) | 获取工作线程数量 | - -### 并行 for - -| 方法 | 描述 | -|------|------| | [`ParallelFor`](parallelfor.md) | 并行执行 for 循环 | - -### 主线程 - -| 方法 | 描述 | -|------|------| | [`RunOnMainThread`](runonmainthread.md) | 将任务提交到主线程执行 | | [`Update`](update.md) | 在主线程中处理主线程队列 | diff --git a/docs/api/threading/task/task.md b/docs/api/threading/task/task.md index eeb3de04..4b33cf8d 100644 --- a/docs/api/threading/task/task.md +++ b/docs/api/threading/task/task.md @@ -37,9 +37,7 @@ | `Failed` | 失败 | | `Canceled` | 已取消 | -## ITask 公共方法 - -### 生命周期 +## 公共方法 | 方法 | 描述 | |------|------| @@ -49,22 +47,12 @@ | [`Execute`](execute.md) | 任务执行逻辑（纯虚） | | [`OnComplete`](oncomplete.md) | 任务完成回调（可重写） | | [`OnCancel`](oncancel.md) | 任务取消回调（可重写） | - -### 属性 - -| 方法 | 描述 | -|------|------| | [`GetPriority`](getpriority.md) | 获取优先级 | | [`GetStatus`](getstatus.md) | 获取状态 | | [`GetId`](getid.md) | 获取任务 ID | | [`SetId`](setid.md) | 设置任务 ID | | [`SetPriority`](setpriority.md) | 设置优先级 | | [`SetStatus`](setstatus.md) | 设置状态 | - -### 引用计数 - -| 方法 | 描述 | -|------|------| | [`AddRef`](addref.md) | 增加引用计数 | | [`Release`](release.md) | 减少引用计数（引用归零时自动 delete） | diff --git a/docs/api/threading/thread/thread.md b/docs/api/threading/thread/thread.md index bf34d032..a6887b9d 100644 --- a/docs/api/threading/thread/thread.md +++ b/docs/api/threading/thread/thread.md @@ -20,32 +20,15 @@ ## 公共方法 -### 生命周期 - | 方法 | 描述 | |------|------| | `Thread()` | 默认构造函数 | | `~Thread()` | 析构函数 | - -### 线程控制 - -| 方法 | 描述 | -|------|------| | [`Start`](start.md) | 启动线程，执行传入的函数 | | [`Join`](join.md) | 等待线程结束 | | [`Detach`](detach.md) | 分离线程，使其独立运行 | - -### 属性访问 - -| 方法 | 描述 | -|------|------| | [`GetId`](getid.md) | 获取线程 ID | | [`GetName`](getname.md) | 获取线程名称 | - -### 静态方法 - -| 方法 | 描述 | -|------|------| | [`GetCurrentId`](getcurrentid.md) | 获取当前线程 ID | | [`Sleep`](sleep.md) | 线程休眠指定毫秒数 | | [`Yield`](yield.md) | 让出当前线程的时间片 |