docs: update RHI API docs

This commit is contained in:
2026-03-20 02:35:45 +08:00
parent ea756c0177
commit 070b444f8f
501 changed files with 13493 additions and 2022 deletions

View File

@@ -2,12 +2,24 @@
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 深度模板视图实现。
**描述**: OpenGL 深度模板视图实现,用于管理深度缓冲区和模板缓冲区的帧缓冲对象
## 概述
`OpenGLDepthStencilView` 类封装了 OpenGL 深度模板视图Depth-Stencil View的功能通过帧缓冲对象Framebuffer Object管理深度缓冲区和模板缓冲区。该类支持多种纹理类型包括 2D 纹理、2D 纹理数组和立方体贴图。
主要功能:
- 创建和管理深度模板帧缓冲对象
- 绑定/解绑深度模板视图到渲染管线
- 清除深度缓冲区和/或模板缓冲区的值
- 查询视图相关的纹理和帧缓冲信息
## 公共方法
| 方法 | 描述 |
|------|------|
| [`OpenGLDepthStencilView`](constructor.md) | 构造函数 |
| [`~OpenGLDepthStencilView`](destructor.md) | 析构函数 |
| [`Initialize`](initialize.md) | 初始化深度模板视图 |
| [`InitializeCubemap`](initialize-cubemap.md) | 初始化立方体贴图深度模板视图 |
| [`Shutdown`](shutdown.md) | 关闭深度模板视图 |
@@ -24,6 +36,12 @@
| [`BindFramebuffer`](bind-framebuffer.md) | 绑定帧缓冲 |
| [`UnbindFramebuffer`](unbind-framebuffer.md) | 解绑帧缓冲 |
## 相关结构体与枚举
- [`OpenGLDepthStencilViewDesc`](openGLDepthStencilViewDesc.md) - 深度模板视图描述结构体
- [`DepthStencilFormat`](depth-stencil-format.md) - 深度模板格式枚举
- [`DepthStencilType`](depth-stencil-type.md) - 深度模板类型枚举
## 相关文档
- [OpenGL 后端总览](../overview.md)