Files
XCEngine/docs/api/XCEngine/Rendering/Passes/BuiltinDepthOnlyPass/BuiltinDepthOnlyPass.md

34 lines
1.5 KiB
Markdown

# BuiltinDepthOnlyPass
**命名空间**: `XCEngine::Rendering::Passes`
**类型**: `class`
**头文件**: `XCEngine/Rendering/Passes/BuiltinDepthOnlyPass.h`
**描述**: `BuiltinDepthStylePassBase``DepthOnly` 特化,使用 builtin depth-only shader 执行只写深度的场景重绘。
## 概览
`BuiltinDepthOnlyPass` 当前没有新增渲染流程;它主要做两件事:
- 在构造时把基类 pass 类型固定为 `BuiltinMaterialPass::DepthOnly`,并注入 builtin depth-only shader 路径。
- 通过 [GetName](GetName.md) 和 [BuildInputLayout](BuildInputLayout.md) 暴露当前 pass 的公开身份与顶点布局。
- `CameraRenderer` 默认把它挂在 `depthOnly` request 槽位上;如果请求被触发,执行时仍沿用基类对 `colorAttachments[0]``depthAttachment` 的双附件要求。
真正的初始化、执行和资源释放逻辑仍由 [BuiltinDepthStylePassBase](../BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md) 提供。
## 公开方法
| 成员 | 说明 |
|------|------|
| [Constructor](Constructor.md) | 构造 depth-only pass。 |
| [Destructor](Destructor.md) | 默认析构,实际 teardown 由基类析构兜底。 |
| [BuildInputLayout](BuildInputLayout.md) | 返回共用 `StaticMeshVertex` 布局。 |
| [GetName](GetName.md) | 返回固定名字 `"BuiltinDepthOnlyPass"`。 |
## 相关文档
- [BuiltinDepthStylePassBase](../BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md)
- [BuiltinShadowCasterPass](../BuiltinShadowCasterPass/BuiltinShadowCasterPass.md)