Files
XCEngine/docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md
ssdfasd 1cf744b755 refactor(docs): RHI模块文档重构 - 修复18处链接错误并新增RHIFramebuffer/RHIRenderPass文档
- 修复opengl/下13个文件对overview.md的错误引用,改为opengl.md
- 修复opengl/shader/下2处get-native-handle.md的错误路径引用
- 修复rhi.md中rhifactory路径错误
- 修复opengl.md中对d3d12.md的错误引用
- 修复opengl/README.md中的overview.md引用
- 新增RHIFramebuffer完整文档(7个文件)
- 新增RHIRenderPass完整文档(7个文件)
- 更新rhi.md总览页,添加RHIFramebuffer和RHIRenderPass分类
2026-03-26 01:29:00 +08:00

48 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OpenGLDepthStencilView
**命名空间**: `XCEngine::RHI`
**描述**: 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) | 关闭深度模板视图 |
| [`Bind`](bind.md) | 绑定深度模板视图 |
| [`Unbind`](unbind.md) | 解绑深度模板视图 |
| [`ClearDepth`](clear-depth.md) | 清除深度 |
| [`ClearStencil`](clear-stencil.md) | 清除模板 |
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度和模板 |
| [`GetFramebuffer`](get-framebuffer.md) | 获取帧缓冲 |
| [`GetTexture`](get-texture.md) | 获取纹理 |
| [`GetMipLevel`](get-mip-level.md) | 获取 Mip 级别 |
| [`GetWidth`](get-size.md) | 获取宽度 |
| [`GetHeight`](get-size.md) | 获取高度 |
| [`BindFramebuffer`](bind-framebuffer.md) | 绑定帧缓冲 |
| [`UnbindFramebuffer`](unbind-framebuffer.md) | 解绑帧缓冲 |
## 相关结构体与枚举
- [`OpenGLDepthStencilViewDesc`](openGLDepthStencilViewDesc.md) - 深度模板视图描述结构体
- [`DepthStencilFormat`](depth-stencil-format.md) - 深度模板格式枚举
- [`DepthStencilType`](depth-stencil-type.md) - 深度模板类型枚举
## 相关文档
- [OpenGL 后端总览](../opengl.md)