Update API documentation and remove obsolete plan files
This commit is contained in:
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) - 关闭方法
|
||||
Reference in New Issue
Block a user