Update API documentation and remove obsolete plan files
This commit is contained in:
@@ -0,0 +1,28 @@
|
||||
# D3D12CommandList::ClearUnorderedAccessView
|
||||
|
||||
```cpp
|
||||
void ClearUnorderedAccessView(
|
||||
D3D12_GPU_DESCRIPTOR_HANDLE viewHandle,
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE resourceHandle,
|
||||
ID3D12Resource* unorderedAccess,
|
||||
const float values[4],
|
||||
uint32_t rectCount = 0,
|
||||
const D3D12_RECT* rects = nullptr
|
||||
);
|
||||
```
|
||||
|
||||
清除无序访问视图。
|
||||
|
||||
**参数:**
|
||||
- `viewHandle` - GPU 描述符句柄
|
||||
- `resourceHandle` - CPU 描述符句柄
|
||||
- `unorderedAccess` - UAV 资源指针
|
||||
- `values` - 清除值 [x, y, z, w]
|
||||
- `rectCount` - 清除矩形数量
|
||||
- `rects` - 清除矩形数组
|
||||
|
||||
**复杂度:** O(n) 其中 n 为 rectCount
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12CommandList 总览](command-list.md) - 返回类总览
|
||||
@@ -21,8 +21,8 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`D3D12CommandList`](../../../threading/lambdatask/constructor.md) | 构造函数 |
|
||||
| [`~D3D12CommandList`](../../../threading/readwritelock/destructor.md) | 析构函数 |
|
||||
| [`D3D12CommandList`](constructor.md) | 构造函数 |
|
||||
| [`~D3D12CommandList`](destructor.md) | 析构函数 |
|
||||
| [`Initialize`](initialize.md) | 初始化命令列表 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭命令列表 |
|
||||
| [`Reset`](reset.md) | 重置命令列表 |
|
||||
@@ -51,6 +51,8 @@
|
||||
| [`SetGraphicsRootDescriptorTable`](set-graphics-root-descriptor-table.md) | 设置图形根描述符表 |
|
||||
| [`SetGraphicsRootShaderResourceView`](set-graphics-root-shader-resource-view.md) | 设置图形根着色器资源视图 |
|
||||
| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 |
|
||||
| [`SetDepthStencilState`](set-depth-stencil-state.md) | 设置深度模板状态 |
|
||||
| [`SetBlendState`](set-blend-state.md) | 设置混合状态 |
|
||||
| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 |
|
||||
| [`SetDepthBias`](set-depth-bias.md) | 设置深度偏移 |
|
||||
| [`Draw`](draw.md) | 绘制 |
|
||||
@@ -60,6 +62,7 @@
|
||||
| [`Clear`](clear.md) | 清除 |
|
||||
| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 |
|
||||
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 |
|
||||
| [`ClearUnorderedAccessView`](clear-unordered-access-view.md) | 清除无序访问视图 |
|
||||
| [`CopyResource`](copy-resource.md) | 复制资源 |
|
||||
| [`CopyBuffer`](copy-buffer.md) | 复制缓冲区 |
|
||||
| [`CopyTexture`](copy-texture.md) | 复制纹理 |
|
||||
|
||||
16
docs/api/rhi/d3d12/command-list/set-blend-state.md
Normal file
16
docs/api/rhi/d3d12/command-list/set-blend-state.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# D3D12CommandList::SetBlendState
|
||||
|
||||
```cpp
|
||||
void SetBlendState(const BlendState& state) override;
|
||||
```
|
||||
|
||||
设置混合状态。
|
||||
|
||||
**参数:**
|
||||
- `state` - 混合状态结构体
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12CommandList 总览](command-list.md) - 返回类总览
|
||||
16
docs/api/rhi/d3d12/command-list/set-depth-stencil-state.md
Normal file
16
docs/api/rhi/d3d12/command-list/set-depth-stencil-state.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# D3D12CommandList::SetDepthStencilState
|
||||
|
||||
```cpp
|
||||
void SetDepthStencilState(const DepthStencilState& state) override;
|
||||
```
|
||||
|
||||
设置深度模板状态。
|
||||
|
||||
**参数:**
|
||||
- `state` - 深度模板状态结构体
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12CommandList 总览](command-list.md) - 返回类总览
|
||||
@@ -74,4 +74,4 @@
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [OpenGL 后端](../opengl/overview.md)
|
||||
- [OpenGL 后端](../opengl/opengl.md)
|
||||
|
||||
27
docs/api/rhi/d3d12/depth-stencil-view/constructor.md
Normal file
27
docs/api/rhi/d3d12/depth-stencil-view/constructor.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# D3D12DepthStencilView::D3D12DepthStencilView
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
D3D12DepthStencilView()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
默认构造函数。创建空的深度模板视图实例,成员变量初始化为零值和空指针。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12DepthStencilView dsv; // 创建空实例
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DepthStencilView](depth-stencil-view.md) - 类总览
|
||||
- [D3D12DepthStencilView::Initialize](initialize.md) - 初始化方法
|
||||
- [D3D12DepthStencilView::~D3D12DepthStencilView](destructor.md) - 析构函数
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/RHI/D3D12/D3D12DepthStencilView.h`
|
||||
|
||||
**描述**: DirectX 12 深度模板视图的 D3D12 实现,用于渲染管线中的深度/模板测试。
|
||||
|
||||
## 概述
|
||||
@@ -14,8 +16,8 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`D3D12DepthStencilView()`](initialize.md) | 构造函数 |
|
||||
| [`~D3D12DepthStencilView()`](initialize.md) | 析构函数 |
|
||||
| [`D3D12DepthStencilView()`](constructor.md) | 构造函数 |
|
||||
| [`~D3D12DepthStencilView()`](destructor.md) | 析构函数 |
|
||||
| [`Initialize`](initialize.md) | 初始化深度模板视图 |
|
||||
| [`InitializeAt`](initialize-at.md) | 在指定位置初始化深度模板视图 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭深度模板视图 |
|
||||
|
||||
34
docs/api/rhi/d3d12/depth-stencil-view/destructor.md
Normal file
34
docs/api/rhi/d3d12/depth-stencil-view/destructor.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# D3D12DepthStencilView::~D3D12DepthStencilView
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
~D3D12DepthStencilView()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
析构函数。自动调用 `Shutdown()` 释放内部资源。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 注意事项
|
||||
|
||||
此析构函数不直接释放 D3D12 资源,仅清理类内部状态。实际资源释放由描述符堆管理。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
{
|
||||
D3D12DepthStencilView dsv;
|
||||
dsv.Initialize(device, depthBuffer, nullptr);
|
||||
// 使用 dsv...
|
||||
} // dsv 析构时自动调用 Shutdown()
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DepthStencilView](depth-stencil-view.md) - 类总览
|
||||
- [D3D12DepthStencilView::Shutdown](shutdown.md) - 关闭方法
|
||||
@@ -59,4 +59,4 @@ heap.Shutdown();
|
||||
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
- [RHIDescriptorPool](../../descriptor-pool/descriptor-pool.md) - 抽象描述符池接口
|
||||
- [D3D12Enum](d3d12-enum.md) - D3D12 类型枚举映射
|
||||
- [D3D12Enum](../enums/enums.md) - D3D12 类型枚举映射
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/RHI/D3D12/D3D12RenderTargetView.h`
|
||||
|
||||
**描述**: DirectX 12 渲染目标视图的 D3D12 实现,用于在渲染管线中作为渲染目标使用。
|
||||
|
||||
## 公共方法
|
||||
|
||||
27
docs/api/rhi/d3d12/root-signature/constructor.md
Normal file
27
docs/api/rhi/d3d12/root-signature/constructor.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# D3D12RootSignature::D3D12RootSignature
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
D3D12RootSignature()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
默认构造函数。创建空的根签名实例,成员变量初始化为零值和空指针。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12RootSignature rootSig; // 创建空实例
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RootSignature](root-signature.md) - 类总览
|
||||
- [D3D12RootSignature::Initialize](initialize.md) - 初始化方法
|
||||
- [D3D12RootSignature::~D3D12RootSignature](destructor.md) - 析构函数
|
||||
34
docs/api/rhi/d3d12/root-signature/destructor.md
Normal file
34
docs/api/rhi/d3d12/root-signature/destructor.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# D3D12RootSignature::~D3D12RootSignature
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
~D3D12RootSignature()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
析构函数。自动调用 `Shutdown()` 释放内部资源。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 注意事项
|
||||
|
||||
此析构函数自动调用 Shutdown() 确保资源被正确释放。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
{
|
||||
D3D12RootSignature rootSig;
|
||||
rootSig.Initialize(device, desc);
|
||||
// 使用 rootSig...
|
||||
} // rootSig 析构时自动调用 Shutdown()
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RootSignature](root-signature.md) - 类总览
|
||||
- [D3D12RootSignature::Shutdown](shutdown.md) - 关闭方法
|
||||
@@ -4,12 +4,16 @@
|
||||
|
||||
**类型**: `class` (D3D12-specific, does not inherit from RHI)
|
||||
|
||||
**头文件**: `XCEngine/RHI/D3D12/D3D12RootSignature.h`
|
||||
|
||||
**描述**: DirectX 12 根签名的 D3D12 实现,提供根签名序列化、参数创建等功能。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`D3D12RootSignature`](constructor.md) | 构造函数 |
|
||||
| [`~D3D12RootSignature`](destructor.md) | 析构函数 |
|
||||
| [`Initialize`](initialize.md) | 初始化根签名 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭根签名 |
|
||||
| [`GetRootSignature`](get-root-signature.md) | 获取 D3D12 根签名 |
|
||||
@@ -44,4 +48,4 @@ if (rootSig.Initialize(device, desc)) {
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
|
||||
@@ -13,4 +13,4 @@
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
|
||||
@@ -45,4 +45,4 @@ delete srv;
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端概览](../d3d12.md)
|
||||
- [OpenGL 后端](../../opengl/overview.md)
|
||||
- [OpenGL 后端](../../opengl/opengl.md)
|
||||
|
||||
Reference in New Issue
Block a user