docs(api): refine D3D12 render pass and framebuffer docs

This commit is contained in:
2026-03-28 00:25:34 +08:00
parent 93d16f3914
commit cd756ec9a3
29 changed files with 432 additions and 491 deletions

View File

@@ -1,30 +1,23 @@
# D3D12Framebuffer::GetWidth
获取相关状态或对象。
```cpp
uint32_t GetWidth() const override;
```
该方法声明于 `XCEngine/RHI/D3D12/D3D12Framebuffer.h`,当前页面用于固定 `D3D12Framebuffer` 类目录下的方法级 canonical 路径。
## 作用
**参数:**
返回 framebuffer 当前缓存的宽度
**返回:** `uint32_t` - 返回值语义详见头文件声明。
## 当前实现行为
**示例:**
- 直接返回 `m_width`
- 不从附件纹理重新查询真实尺寸
```cpp
#include <XCEngine/RHI/D3D12/D3D12Framebuffer.h>
## 注意事项
void Example() {
XCEngine::RHI::D3D12Framebuffer object;
// 根据上下文补齐参数后调用 D3D12Framebuffer::GetWidth(...)。
(void)object;
}
```
这个值完全来自 [Initialize](Initialize.md) 的传参。即使附件本身尺寸不同,这里也不会自动纠正。
## 相关文档
- [返回类总览](D3D12Framebuffer.md)
- [返回模块目录](../D3D12.md)
- [GetHeight](GetHeight.md)
- [Initialize](Initialize.md)