docs: update RHI API docs
This commit is contained in:
27
docs/api/rhi/d3d12/render-target-view/constructor.md
Normal file
27
docs/api/rhi/d3d12/render-target-view/constructor.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# D3D12RenderTargetView::D3D12RenderTargetView
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
D3D12RenderTargetView()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
默认构造函数。创建空的渲染目标视图实例,成员变量初始化为零值和空指针。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12RenderTargetView rtv; // 创建空实例
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::Initialize](initialize.md) - 初始化方法
|
||||
- [D3D12RenderTargetView::~D3D12RenderTargetView](destructor.md) - 析构函数
|
||||
@@ -6,20 +6,20 @@
|
||||
static D3D12_RENDER_TARGET_VIEW_DESC CreateDesc(Format format, D3D12_RTV_DIMENSION dimension = D3D12_RTV_DIMENSION_TEXTURE2D)
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
## 描述
|
||||
|
||||
创建渲染目标视图描述符。
|
||||
创建渲染目标视图描述符的便捷静态方法。将引擎格式枚举转换为 D3D12 格式,并设置视图维度。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `format` | `Format` | 资源格式 |
|
||||
| `dimension` | `D3D12_RTV_DIMENSION` | 视图维度(默认 TEXTURE2D) |
|
||||
| `format` | `Format` | 资源格式(参见 `RHIEnums.h` 中的 Format 枚举) |
|
||||
| `dimension` | `D3D12_RTV_DIMENSION` | 视图维度(默认 `D3D12_RTV_DIMENSION_TEXTURE2D`) |
|
||||
|
||||
## 返回值
|
||||
|
||||
`D3D12_RENDER_TARGET_VIEW_DESC` - 渲染目标视图描述符
|
||||
`D3D12_RENDER_TARGET_VIEW_DESC` - 渲染目标视图描述符结构体
|
||||
|
||||
## 复杂度
|
||||
|
||||
@@ -28,9 +28,12 @@ O(1)
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
// 创建典型纹理2D渲染目标描述符
|
||||
D3D12_RENDER_TARGET_VIEW_DESC desc = D3D12RenderTargetView::CreateDesc(Format::R8G8B8A8_UNorm);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12_RENDER_TARGET_VIEW_DESC](https://docs.microsoft.com/en-us/windows/win32/api/d3d12/ns-d3d12-d3d12_render_target_view_desc)
|
||||
- [Format 枚举](../enums.md#Format)
|
||||
34
docs/api/rhi/d3d12/render-target-view/destructor.md
Normal file
34
docs/api/rhi/d3d12/render-target-view/destructor.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# D3D12RenderTargetView::~D3D12RenderTargetView
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
~D3D12RenderTargetView()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
析构函数。自动调用 `Shutdown()` 释放内部资源。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 注意事项
|
||||
|
||||
此析构函数不直接释放 D3D12 资源,仅清理类内部状态。实际资源释放由描述符堆管理。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
{
|
||||
D3D12RenderTargetView rtv;
|
||||
rtv.Initialize(device, resource, &desc);
|
||||
// 使用 rtv...
|
||||
} // rtv 析构时自动调用 Shutdown()
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::Shutdown](shutdown.md) - 关闭方法
|
||||
@@ -6,9 +6,9 @@
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE GetCPUDescriptorHandle() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
## 描述
|
||||
|
||||
获取渲染目标视图的 CPU 描述符句柄。
|
||||
获取渲染目标视图的 CPU 描述符句柄。返回的句柄用于绑定 RTV 到渲染管线命令列表。
|
||||
|
||||
## 返回值
|
||||
|
||||
@@ -21,9 +21,11 @@ O(1)
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE handle = rtv->GetCPUDescriptorHandle();
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE handle = rtv.GetCPUDescriptorHandle();
|
||||
commandList->OMSetRenderTargets(1, &handle, FALSE, nullptr);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [OMSetRenderTargets (D3D12)](https://docs.microsoft.com/en-us/windows/win32/api/d3d12/nf-d3d12-id3d12graphicscommandlist-omsetrendertargets)
|
||||
@@ -6,18 +6,18 @@
|
||||
void InitializeAt(ID3D12Device* device, ID3D12Resource* resource, D3D12_CPU_DESCRIPTOR_HANDLE handle, const D3D12_RENDER_TARGET_VIEW_DESC* desc = nullptr)
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
## 描述
|
||||
|
||||
在指定描述符句柄位置初始化渲染目标视图,用于外部描述符堆管理场景。
|
||||
在指定描述符句柄位置初始化渲染目标视图,用于外部描述符堆管理场景。此方法允许将 RTV 创建在预分配的描述符位置,便于批量管理描述符。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `device` | `ID3D12Device*` | D3D12 设备指针 |
|
||||
| `resource` | `ID3D12Resource*` | 资源指针 |
|
||||
| `handle` | `D3D12_CPU_DESCRIPTOR_HANDLE` | 预分配的描述符句柄 |
|
||||
| `desc` | `D3D12_RENDER_TARGET_VIEW_DESC*` | 视图描述符(可选) |
|
||||
| `resource` | `ID3D12Resource*` | 渲染目标资源指针 |
|
||||
| `handle` | `D3D12_CPU_DESCRIPTOR_HANDLE` | 预分配的描述符句柄位置 |
|
||||
| `desc` | `D3D12_RENDER_TARGET_VIEW_DESC*` | 视图描述符(可选,传入 nullptr 使用资源默认格式) |
|
||||
|
||||
## 返回值
|
||||
|
||||
@@ -30,11 +30,13 @@ O(1)
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
// 从描述符堆获取句柄
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE handle = descriptorHeap->GetCPUDescriptorHandleForHeapStart();
|
||||
rtv->InitializeAt(device, resource, handle);
|
||||
rtv.InitializeAt(device, resource, handle);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::Initialize](../../../threading/task-system/initialize.md) - 标准初始化
|
||||
- [D3D12RenderTargetView::Initialize](initialize.md) - 标准初始化
|
||||
- [D3D12DescriptorHeap](../descriptor-heap/descriptor-heap.md) - 描述符堆管理
|
||||
35
docs/api/rhi/d3d12/render-target-view/initialize.md
Normal file
35
docs/api/rhi/d3d12/render-target-view/initialize.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# D3D12RenderTargetView::Initialize
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
void Initialize(ID3D12Device* device, ID3D12Resource* resource, const D3D12_RENDER_TARGET_VIEW_DESC* desc = nullptr)
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
初始化渲染目标视图。内部自动分配描述符句柄。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `device` | `ID3D12Device*` | D3D12 设备指针 |
|
||||
| `resource` | `ID3D12Resource*` | 渲染目标资源指针 |
|
||||
| `desc` | `D3D12_RENDER_TARGET_VIEW_DESC*` | 视图描述符(可选) |
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12RenderTargetView rtv;
|
||||
rtv.Initialize(device, resource, &desc);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::InitializeAt](initialize-at.md) - 在指定位置初始化
|
||||
@@ -2,18 +2,35 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 渲染目标视图的 D3D12 实现。
|
||||
**描述**: DirectX 12 渲染目标视图的 D3D12 实现,用于在渲染管线中作为渲染目标使用。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化渲染目标视图 |
|
||||
| [`D3D12RenderTargetView`](constructor.md) | 构造函数 |
|
||||
| [`~D3D12RenderTargetView`](destructor.md) | 析构函数 |
|
||||
| [`Initialize`](initialize.md) | 初始化渲染目标视图 |
|
||||
| [`InitializeAt`](initialize-at.md) | 在指定位置初始化 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭渲染目标视图 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭渲染目标视图 |
|
||||
| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 |
|
||||
| [`CreateDesc`](create-desc.md) | 创建描述符(静态) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
// 创建 RTV
|
||||
D3D12RenderTargetView rtv;
|
||||
rtv.Initialize(device, resource, &desc);
|
||||
|
||||
// 使用
|
||||
device->CreateRenderTargetView(resource, &desc, rtv.GetCPUDescriptorHandle());
|
||||
|
||||
// 清理
|
||||
rtv.Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
- [D3D12DescriptorHeap](../descriptor-heap/descriptor-heap.md)
|
||||
26
docs/api/rhi/d3d12/render-target-view/shutdown.md
Normal file
26
docs/api/rhi/d3d12/render-target-view/shutdown.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# D3D12RenderTargetView::Shutdown
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
void Shutdown()
|
||||
```
|
||||
|
||||
## 描述
|
||||
|
||||
关闭渲染目标视图,释放内部资源。
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
rtv.Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::Initialize](initialize.md) - 初始化
|
||||
Reference in New Issue
Block a user