Docs: Add D3D12 swap chain and texture API docs
This commit is contained in:
35
docs/api/d3d12/d3d12-swap-chain.md
Normal file
35
docs/api/d3d12/d3d12-swap-chain.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# D3D12SwapChain
|
||||||
|
|
||||||
|
**命名空间**: `XCEngine::RHI`
|
||||||
|
|
||||||
|
**类型**: `class`
|
||||||
|
|
||||||
|
**头文件**: `XCEngine/RHI/D3D12/D3D12SwapChain.h`
|
||||||
|
|
||||||
|
**描述**: DirectX 12 交换链封装类,管理帧缓冲和呈现操作
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
D3D12SwapChain 是 DirectX 12 交换链的封装类,继承自 RHISwapChain 接口。负责管理前后缓冲交换、呈现操作和窗口事件处理。
|
||||||
|
|
||||||
|
## 公共方法
|
||||||
|
|
||||||
|
| 方法 | 描述 |
|
||||||
|
|------|------|
|
||||||
|
| `D3D12SwapChain()` | 默认构造函数 |
|
||||||
|
| `~D3D12SwapChain()` | 虚析构函数 |
|
||||||
|
| [Initialize](d3d12-swap-chain-initialize.md) | 初始化交换链 |
|
||||||
|
| [Shutdown](d3d12-swap-chain-shutdown.md) | 关闭交换链 |
|
||||||
|
| [GetCurrentBackBufferIndex](d3d12-swap-chain-get-current-back-buffer-index.md) | 获取当前后缓冲索引 |
|
||||||
|
| [GetCurrentBackBuffer](d3d12-swap-chain-get-current-back-buffer.md) | 获取当前后缓冲 |
|
||||||
|
| [Present](d3d12-swap-chain-present.md) | 呈现 |
|
||||||
|
| [Resize](d3d12-swap-chain-resize.md) | 调整大小 |
|
||||||
|
| [SetFullscreen](d3d12-swap-chain-set-fullscreen.md) | 设置全屏 |
|
||||||
|
| [IsFullscreen](d3d12-swap-chain-is-fullscreen.md) | 检查全屏状态 |
|
||||||
|
| [ShouldClose](d3d12-swap-chain-should-close.md) | 检查是否应关闭 |
|
||||||
|
| [PollEvents](d3d12-swap-chain-poll-events.md) | 轮询窗口事件 |
|
||||||
|
|
||||||
|
## 相关文档
|
||||||
|
|
||||||
|
- [D3D12 模块概览](d3d12.md) - D3D12 模块总览
|
||||||
|
- [RHISwapChain](../rhi-swap-chain.md) - RHI 交换链基类
|
||||||
38
docs/api/d3d12/d3d12-texture.md
Normal file
38
docs/api/d3d12/d3d12-texture.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# D3D12Texture
|
||||||
|
|
||||||
|
**命名空间**: `XCEngine::RHI`
|
||||||
|
|
||||||
|
**类型**: `class`
|
||||||
|
|
||||||
|
**头文件**: `XCEngine/RHI/D3D12/D3D12Texture.h`
|
||||||
|
|
||||||
|
**描述**: DirectX 12 纹理资源封装类,支持 1D/2D/3D/立方体纹理
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
|
||||||
|
D3D12Texture 是 DirectX 12 纹理资源的封装类,继承自 RHITexture 接口。支持多种纹理类型,包括 1D、2D、3D 纹理和立方体纹理。提供了从数据初始化和深度模板纹理初始化的功能。
|
||||||
|
|
||||||
|
## 公共方法
|
||||||
|
|
||||||
|
| 方法 | 描述 |
|
||||||
|
|------|------|
|
||||||
|
| `D3D12Texture()` | 默认构造函数 |
|
||||||
|
| `~D3D12Texture()` | 虚析构函数 |
|
||||||
|
| [Initialize](d3d12-texture-initialize.md) | 初始化纹理 |
|
||||||
|
| [InitializeFromExisting](d3d12-texture-initialize-from-existing.md) | 从现有资源初始化 |
|
||||||
|
| [InitializeFromData](d3d12-texture-initialize-from-data.md) | 从数据初始化 |
|
||||||
|
| [InitializeDepthStencil](d3d12-texture-initialize-depth-stencil.md) | 初始化深度模板纹理 |
|
||||||
|
| [Shutdown](d3d12-texture-shutdown.md) | 关闭纹理 |
|
||||||
|
| [GetResource](d3d12-texture-get-resource.md) | 获取底层资源指针 |
|
||||||
|
| [GetDesc](d3d12-texture-get-desc.md) | 获取资源描述 |
|
||||||
|
| [GetWidth](d3d12-texture-get-width.md) | 获取宽度 |
|
||||||
|
| [GetHeight](d3d12-texture-get-height.md) | 获取高度 |
|
||||||
|
| [GetDepth](d3d12-texture-get-depth.md) | 获取深度 |
|
||||||
|
| [GetMipLevels](d3d12-texture-get-mip-levels.md) | 获取 Mip 级别数 |
|
||||||
|
| [GetState](d3d12-texture-get-state.md) | 获取资源状态 |
|
||||||
|
| [SetState](d3d12-texture-set-state.md) | 设置资源状态 |
|
||||||
|
|
||||||
|
## 相关文档
|
||||||
|
|
||||||
|
- [D3D12 模块概览](d3d12.md) - D3D12 模块总览
|
||||||
|
- [RHITexture](../rhi-texture.md) - RHI 纹理基类
|
||||||
Reference in New Issue
Block a user