docs: add second-round api structure refactor plan
This commit is contained in:
@@ -42,6 +42,7 @@
|
||||
| [AssetReferenceEditorUtils](AssetReferenceEditorUtils/AssetReferenceEditorUtils.md) | 资产引用属性行 helper。 |
|
||||
| [MeshFilterComponentEditor](MeshFilterComponentEditor/MeshFilterComponentEditor.md) | MeshFilter 组件 Inspector。 |
|
||||
| [MeshRendererComponentEditor](MeshRendererComponentEditor/MeshRendererComponentEditor.md) | MeshRenderer 组件 Inspector。 |
|
||||
| [VolumeRendererComponentEditor](VolumeRendererComponentEditor/VolumeRendererComponentEditor.md) | VolumeRenderer 组件 Inspector。 |
|
||||
| [ScriptComponentEditor](ScriptComponentEditor/ScriptComponentEditor.md) | Script 组件 Inspector 与脚本字段编辑入口。 |
|
||||
| [ScriptComponentEditorUtils](ScriptComponentEditorUtils/ScriptComponentEditorUtils.md) | 脚本组件编辑器辅助规则与格式化 helper。 |
|
||||
|
||||
@@ -54,9 +55,10 @@
|
||||
- `LightComponentEditor`
|
||||
- `MeshFilterComponentEditor`
|
||||
- `MeshRendererComponentEditor`
|
||||
- `VolumeRendererComponentEditor`
|
||||
- `ScriptComponentEditor`
|
||||
|
||||
这说明当前组件编辑器系统已经不再只覆盖基础三组件，而是已经承载渲染组件和脚本组件的 Inspector 逻辑。当前 canonical 树已经把渲染组件 editor、脚本组件 editor 和它们共用的资产引用 helper 都补齐了。
|
||||
这说明当前组件编辑器系统已经不再只覆盖基础三组件，而是已经承载 mesh、volume 与脚本组件的 Inspector 逻辑。当前 canonical 树已经把这些渲染组件 editor、脚本组件 editor 和它们共用的资产引用 helper 都补齐了。
|
||||
|
||||
## ScriptComponentEditor 的特殊性
|
||||
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
# VolumeRendererComponentEditor
|
||||
|
||||
**命名空间**: `XCEngine::Editor`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**源文件**: `editor/src/ComponentEditors/VolumeRendererComponentEditor.h`
|
||||
|
||||
**描述**: `VolumeRendererComponent` 的 Inspector editor，负责绘制体积资源引用、材质引用以及阴影开关。
|
||||
|
||||
## 概述
|
||||
|
||||
`VolumeRendererComponentEditor` 当前是内联定义在头文件里的轻量 editor，实现方式与其他 `ComponentEditor` 一致：
|
||||
|
||||
1. 由 `ComponentEditorRegistry` 注册
|
||||
2. 在 `InspectorPanel` 渲染组件 section 时被查到
|
||||
3. 直接通过 `UI::ApplyPropertyChange(...)` 把修改包进 undo 标签
|
||||
|
||||
## 当前实现行为
|
||||
|
||||
### 资源引用编辑
|
||||
|
||||
- `Volume Field`
|
||||
- 通过 `ComponentEditorAssetUI::DrawAssetReferenceProperty(...)` 绘制
|
||||
- 当前接受扩展名 `.nvdb`
|
||||
- 清除时调用 `VolumeRendererComponent::ClearVolumeField()`
|
||||
- 赋值时调用 `SetVolumeFieldPath(...)`
|
||||
- `Material`
|
||||
- 同样使用 `DrawAssetReferenceProperty(...)`
|
||||
- 当前接受扩展名 `.mat`
|
||||
- 清除时调用 `ClearMaterial()`
|
||||
- 赋值时调用 `SetMaterialPath(...)`
|
||||
|
||||
### 布尔属性
|
||||
|
||||
- `Cast Shadows`
|
||||
- `Receive Shadows`
|
||||
|
||||
这两个布尔值都通过 `UI::DrawPropertyBool(...)` 与 `UI::ApplyPropertyChange(...)` 包装到统一 undo 标签：
|
||||
|
||||
- `Modify Volume Renderer`
|
||||
|
||||
### 添加与移除规则
|
||||
|
||||
- `CanAddTo(...)`
|
||||
- 只有目标 `GameObject` 还没有 `VolumeRendererComponent` 时才允许添加
|
||||
- `GetAddDisabledReason(...)`
|
||||
- `nullptr` `GameObject` 返回 `"Invalid"`
|
||||
- 已存在组件返回 `"Already Added"`
|
||||
- `CanRemove(...)`
|
||||
- 当前直接复用 `CanEdit(...)`
|
||||
|
||||
## 测试与调用链
|
||||
|
||||
- `editor/src/ComponentEditors/ComponentEditorRegistry.cpp`
|
||||
- 当前把本 editor 注册进全局 registry
|
||||
- `editor/src/panels/InspectorPanel.cpp`
|
||||
- 当前通过 registry 查找并渲染本 editor
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前没有独立单元测试，行为主要通过 registry 和 Inspector 实际渲染链验证。
|
||||
- 这是 editor-only UI 适配层，不保存状态；真正的数据写回都落在 `VolumeRendererComponent`。
|
||||
- 当前资源过滤只按扩展名限制，不负责进一步校验材质/体积内容是否合法。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ComponentEditors](../ComponentEditors.md)
|
||||
- [ComponentEditorRegistry](../ComponentEditorRegistry/ComponentEditorRegistry.md)
|
||||
- [VolumeRendererComponent](../../../Components/VolumeRendererComponent/VolumeRendererComponent.md)
|
||||
- [InspectorPanel](../../panels/InspectorPanel/InspectorPanel.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# BuiltinSelectionMaskPass::BuildInputLayout
|
||||
|
||||
```cpp
|
||||
static RHI::InputLayoutDesc BuildInputLayout();
|
||||
```
|
||||
|
||||
返回 selection-mask pass 的顶点布局。当前直接复用基类 `BuildCommonInputLayout()`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass.md)
|
||||
@@ -0,0 +1,40 @@
|
||||
# BuiltinSelectionMaskPass
|
||||
|
||||
**命名空间**: `XCEngine::Rendering::Passes`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Rendering/Passes/BuiltinSelectionMaskPass.h`
|
||||
|
||||
**描述**: 选择遮罩 pass，在深度风格重绘框架上只重绘被选中对象，并把结果写入 selection mask 目标。
|
||||
|
||||
## 概览
|
||||
|
||||
`BuiltinSelectionMaskPass` 继承自 [BuiltinDepthStylePassBase](../BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md)。
|
||||
它不重新实现整套场景重绘框架，而是只增加“按选中对象过滤”的那层语义：
|
||||
|
||||
- 外部传入 `selectedObjectIds`
|
||||
- pass 内部记录到 `m_selectedObjectIds`
|
||||
- `ShouldRenderVisibleItem(...)` 只让被选中的对象通过
|
||||
|
||||
## 当前流程
|
||||
|
||||
1. [Render](Render.md) 记录选中对象 id 列表
|
||||
2. 若列表为空，直接返回 `false`
|
||||
3. 复制 `sceneData`，把 clear flags 改为纯颜色清屏且清为黑色
|
||||
4. 组装 `RenderPassContext`
|
||||
5. 调用基类 `Execute(...)`
|
||||
|
||||
## 公开方法
|
||||
|
||||
| 方法 | 说明 |
|
||||
|------|------|
|
||||
| [BuildInputLayout](BuildInputLayout.md) | 复用深度风格 pass 的通用顶点布局 |
|
||||
| [GetName](GetName.md) | 返回 `BuiltinSelectionMaskPass` |
|
||||
| [Render](Render.md) | 只重绘选中对象到 selection mask |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Passes](../Passes.md)
|
||||
- [BuiltinDepthStylePassBase](../BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md)
|
||||
- [BuiltinSelectionOutlinePass](../BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# BuiltinSelectionMaskPass::GetName
|
||||
|
||||
```cpp
|
||||
const char* GetName() const override;
|
||||
```
|
||||
|
||||
返回固定名称 `BuiltinSelectionMaskPass`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass.md)
|
||||
@@ -0,0 +1,25 @@
|
||||
# BuiltinSelectionMaskPass::Render
|
||||
|
||||
```cpp
|
||||
bool Render(
|
||||
const RenderContext& context,
|
||||
const RenderSurface& surface,
|
||||
const RenderSceneData& sceneData,
|
||||
const std::vector<uint64_t>& selectedObjectIds);
|
||||
```
|
||||
|
||||
把当前选中对象重绘到 selection mask render target。
|
||||
|
||||
## 当前实现流程
|
||||
|
||||
1. 保存 `selectedObjectIds`
|
||||
2. 若选中列表为空，返回 `false`
|
||||
3. 复制输入 `sceneData`
|
||||
4. 把 `cameraData.clearFlags` 改为 `RenderClearFlags::Color`
|
||||
5. 把 clear color 固定为黑色
|
||||
6. 调用基类 `Execute(...)`
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass.md)
|
||||
- [BuiltinSelectionOutlinePass](../BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)
|
||||
@@ -0,0 +1,60 @@
|
||||
# BuiltinSelectionOutlinePass
|
||||
|
||||
**命名空间**: `XCEngine::Rendering::Passes`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Rendering/Passes/BuiltinSelectionOutlinePass.h`
|
||||
|
||||
**描述**: 基于 selection mask 与 depth 纹理执行的全屏轮廓 pass，用于把选中描边叠加回主颜色目标。
|
||||
|
||||
## 概览
|
||||
|
||||
`BuiltinSelectionOutlinePass` 与 `BuiltinSelectionMaskPass` 分工明确：
|
||||
|
||||
- mask pass 负责把选中对象重绘成二值 mask
|
||||
- outline pass 负责读取 mask 与 depth，执行一次全屏三角形轮廓合成
|
||||
|
||||
它不是 `RenderPass` 子类，而是一个自管理资源的独立 helper。
|
||||
|
||||
## 当前执行流程
|
||||
|
||||
1. [Render](Render.md) 校验 render context、mask view、depth view 和 surface
|
||||
2. `EnsureInitialized(...)` 按后端、render target 格式和采样数准备 pipeline 资源
|
||||
3. 写入 outline 常量
|
||||
4. 更新 selection mask / depth 的 SRV 绑定
|
||||
5. 视情况做资源状态切换
|
||||
6. 绘制一次全屏三角形并恢复资源状态
|
||||
|
||||
## 关键资源
|
||||
|
||||
| 资源 | 说明 |
|
||||
|------|------|
|
||||
| `m_pipelineLayout` / `m_pipelineState` | 全屏 outline pass 的 pipeline |
|
||||
| `m_constantPool` / `m_constantSet` | outline 常量缓冲 |
|
||||
| `m_texturePool` / `m_textureSet` | selection mask 与 depth SRV |
|
||||
| `m_shaderPath` | 当前使用的 selection-outline shader 路径 |
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 只支持单颜色附件输出
|
||||
- 当前不写深度
|
||||
- 输出样式由 [SelectionOutlineStyle](../SelectionOutlineStyle/SelectionOutlineStyle.md) 控制
|
||||
- 输入纹理来源由 [SelectionOutlinePassInputs](../SelectionOutlinePassInputs/SelectionOutlinePassInputs.md) 描述
|
||||
|
||||
## 公开方法
|
||||
|
||||
| 方法 | 说明 |
|
||||
|------|------|
|
||||
| [Constructor](Constructor.md) | 创建 pass，可注入 shader 路径 |
|
||||
| [SetShaderPath](SetShaderPath.md) | 更新 shader 路径并清空已创建资源 |
|
||||
| [GetShaderPath](GetShaderPath.md) | 返回当前 shader 路径 |
|
||||
| [Render](Render.md) | 执行全屏描边合成 |
|
||||
| [Shutdown](Shutdown.md) | 销毁内部 RHI 资源 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Passes](../Passes.md)
|
||||
- [BuiltinSelectionMaskPass](../BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md)
|
||||
- [SelectionOutlineStyle](../SelectionOutlineStyle/SelectionOutlineStyle.md)
|
||||
- [SelectionOutlinePassInputs](../SelectionOutlinePassInputs/SelectionOutlinePassInputs.md)
|
||||
@@ -0,0 +1,17 @@
|
||||
# BuiltinSelectionOutlinePass::BuiltinSelectionOutlinePass
|
||||
|
||||
```cpp
|
||||
explicit BuiltinSelectionOutlinePass(Containers::String shaderPath = Containers::String());
|
||||
```
|
||||
|
||||
创建 selection outline pass。
|
||||
|
||||
## 当前语义
|
||||
|
||||
- 若传入空路径，默认回退到内建 selection-outline shader 路径
|
||||
- 构造后会立即调用内部 `ResetState()`
|
||||
- 资源真正创建发生在第一次 `Render(...)` 或后续 `EnsureInitialized(...)`
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass.md)
|
||||
@@ -0,0 +1,12 @@
|
||||
# BuiltinSelectionOutlinePass::GetShaderPath
|
||||
|
||||
```cpp
|
||||
const Containers::String& GetShaderPath() const;
|
||||
```
|
||||
|
||||
返回当前记录的 selection-outline shader 路径。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass.md)
|
||||
- [SetShaderPath](SetShaderPath.md)
|
||||
@@ -0,0 +1,27 @@
|
||||
# BuiltinSelectionOutlinePass::Render
|
||||
|
||||
```cpp
|
||||
bool Render(
|
||||
const RenderContext& renderContext,
|
||||
const RenderSurface& surface,
|
||||
const SelectionOutlinePassInputs& inputs,
|
||||
const SelectionOutlineStyle& style = {});
|
||||
```
|
||||
|
||||
读取 selection mask 与 depth，并把轮廓叠加回 `surface` 的主颜色目标。
|
||||
|
||||
## 当前实现流程
|
||||
|
||||
1. 校验 render context、mask/depth 纹理与 surface
|
||||
2. `EnsureInitialized(...)`
|
||||
3. 构建 `OutlineConstants`
|
||||
4. 写入常量并更新两个 SRV
|
||||
5. 自动状态切换开启时，把目标切到 `RenderTarget`、输入切到 `PixelShaderResource`
|
||||
6. 绑定两个 descriptor set，执行一次 `Draw(3, 1, 0, 0)`
|
||||
7. 恢复资源状态
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass.md)
|
||||
- [SelectionOutlinePassInputs](../SelectionOutlinePassInputs/SelectionOutlinePassInputs.md)
|
||||
- [SelectionOutlineStyle](../SelectionOutlineStyle/SelectionOutlineStyle.md)
|
||||
@@ -0,0 +1,18 @@
|
||||
# BuiltinSelectionOutlinePass::SetShaderPath
|
||||
|
||||
```cpp
|
||||
void SetShaderPath(const Containers::String& shaderPath);
|
||||
```
|
||||
|
||||
更新 selection-outline shader 路径。
|
||||
|
||||
## 当前行为
|
||||
|
||||
- 若新旧路径相同，直接返回
|
||||
- 若路径发生变化，会先销毁已创建的 pipeline / descriptor 等资源
|
||||
- 后续首次 `Render(...)` 会按新路径重新初始化
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass.md)
|
||||
- [GetShaderPath](GetShaderPath.md)
|
||||
@@ -0,0 +1,18 @@
|
||||
# BuiltinSelectionOutlinePass::Shutdown
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
主动销毁 selection outline pass 已创建的 RHI 资源。
|
||||
|
||||
## 当前行为
|
||||
|
||||
- 释放 pipeline state、pipeline layout
|
||||
- 释放常量与纹理 descriptor pool / set
|
||||
- 清空已加载 shader 句柄
|
||||
- 重置缓存的 render target 格式与采样数
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass.md)
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 承载 builtin object-id、selection outline、infinite grid、fullscreen post-process / final-color，以及 depth-only / shadow-caster 一类可复用渲染 pass 与配套参数类型。
|
||||
**描述**: 承载 builtin object-id、selection mask / outline、volumetric、infinite grid、fullscreen post-process / final-color，以及 depth-only / shadow-caster 一类可复用渲染 pass 与配套参数类型。
|
||||
|
||||
## 概览
|
||||
|
||||
@@ -12,7 +12,10 @@
|
||||
|
||||
- [BuiltinObjectIdPass](BuiltinObjectIdPass/BuiltinObjectIdPass.md) 把可见物体编码成 object-id 颜色，写到辅助渲染目标。
|
||||
- [BuiltinObjectIdOutlinePass](BuiltinObjectIdOutlinePass/BuiltinObjectIdOutlinePass.md) 读取 object-id 纹理和选中对象列表，把轮廓或调试 mask 叠加回场景颜色。
|
||||
- [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md) 重绘当前选中对象，生成 selection mask。
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md) 读取 selection-mask 与 depth 纹理，在主颜色目标上合成轮廓。
|
||||
- [BuiltinInfiniteGridPass](BuiltinInfiniteGridPass/BuiltinInfiniteGridPass.md) 给 Scene View 一类编辑器视口叠加无限网格。
|
||||
- [BuiltinVolumetricPass](BuiltinVolumetricPass/BuiltinVolumetricPass.md) 消费 `visibleVolumes` 与 `VolumeField` GPU 资源，执行体渲染。
|
||||
- [BuiltinColorScalePostProcessPass](BuiltinColorScalePostProcessPass/BuiltinColorScalePostProcessPass.md) 执行基于 `sourceColorView` 的全屏颜色缩放后处理。
|
||||
- [BuiltinFinalColorPass](BuiltinFinalColorPass/BuiltinFinalColorPass.md) 执行 exposure、tone mapping、output transfer 和 final color scale 的最终输出阶段。
|
||||
- [BuiltinDepthStylePassBase](BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md) 为深度风格场景重绘 pass 提供共享执行骨架。
|
||||
@@ -28,7 +31,7 @@
|
||||
1. [CameraRenderer](../CameraRenderer/CameraRenderer.md) 先执行主 `RenderPipeline`。
|
||||
2. 如果 [CameraRenderRequest](../CameraRenderRequest/CameraRenderRequest.md) 里请求了 `objectId.surface`，则额外执行 [BuiltinObjectIdPass](BuiltinObjectIdPass/BuiltinObjectIdPass.md)。
|
||||
3. editor 侧的 `SceneViewportRenderPlan` 再构建 `postScenePasses` 和 `overlayPasses`。
|
||||
4. 其中 `SceneViewportGridPass` / `SceneViewportSelectionOutlinePass` 最终分别调用 [BuiltinInfiniteGridPass](BuiltinInfiniteGridPass/BuiltinInfiniteGridPass.md) 和 [BuiltinObjectIdOutlinePass](BuiltinObjectIdOutlinePass/BuiltinObjectIdOutlinePass.md)。
|
||||
4. 其中 `SceneViewportGridPass` / `SceneViewportSelectionOutlinePass` 当前分别调用 [BuiltinInfiniteGridPass](BuiltinInfiniteGridPass/BuiltinInfiniteGridPass.md) 与“[BuiltinSelectionMaskPass](BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md) + [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)”这一组 selection outline 组合。
|
||||
|
||||
### Fullscreen post-process / final-color
|
||||
|
||||
@@ -48,13 +51,24 @@
|
||||
4. `postScenePasses`
|
||||
5. `overlayPasses`
|
||||
|
||||
### Builtin volume scene pass
|
||||
|
||||
体渲染链路和前面两类流程不同，它不是 post-process，而是 builtin scene pass：
|
||||
|
||||
1. `RenderSceneExtractor` 先把体积对象提取到 `visibleVolumes`。
|
||||
2. [BuiltinForwardPipeline](../Pipelines/BuiltinForwardPipeline/BuiltinForwardPipeline.md) 把 [BuiltinVolumetricPass](BuiltinVolumetricPass/BuiltinVolumetricPass.md) 放进自己的 pass sequence。
|
||||
3. `BuiltinVolumetricPass` 再按材质 shader pass、volume-field 绑定和 lighting 常量逐项绘制。
|
||||
|
||||
## 当前公开概念
|
||||
|
||||
| 类型 / 页面 | 角色 |
|
||||
|------|------|
|
||||
| [BuiltinObjectIdPass](BuiltinObjectIdPass/BuiltinObjectIdPass.md) | 生成 object-id 颜色缓冲。 |
|
||||
| [BuiltinObjectIdOutlinePass](BuiltinObjectIdOutlinePass/BuiltinObjectIdOutlinePass.md) | 在主颜色目标上合成选中轮廓。 |
|
||||
| [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md) | 为选中轮廓链路生成 selection mask。 |
|
||||
| [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md) | 基于 selection-mask 与 depth 的全屏轮廓合成器。 |
|
||||
| [BuiltinInfiniteGridPass](BuiltinInfiniteGridPass/BuiltinInfiniteGridPass.md) | Scene View 网格覆盖层的底层执行 pass。 |
|
||||
| [BuiltinVolumetricPass](BuiltinVolumetricPass/BuiltinVolumetricPass.md) | builtin forward 链路中的体渲染 scene pass。 |
|
||||
| [BuiltinColorScalePostProcessPass](BuiltinColorScalePostProcessPass/BuiltinColorScalePostProcessPass.md) | 相机 post-process 栈当前的颜色缩放全屏 pass。 |
|
||||
| [BuiltinFinalColorPass](BuiltinFinalColorPass/BuiltinFinalColorPass.md) | final-color 阶段的最终合成 / 输出变换 pass。 |
|
||||
| [BuiltinDepthStylePassBase](BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md) | depth-only / shadow-caster 场景重绘共享的执行骨架。 |
|
||||
@@ -66,19 +80,27 @@
|
||||
- `tests/Rendering/unit/test_camera_scene_renderer.cpp` 验证了 `CameraRenderer` 里 object-id、post-process、final-output 与可选 pass sequence 的接入时机。
|
||||
- `engine/src/Rendering/Execution/CameraRenderer.cpp` 当前把 [BuiltinShadowCasterPass](BuiltinShadowCasterPass/BuiltinShadowCasterPass.md) 与 [BuiltinDepthOnlyPass](BuiltinDepthOnlyPass/BuiltinDepthOnlyPass.md) 作为默认 scene pass 挂进 `shadowCaster` / `depthOnly` request。
|
||||
- `engine/src/Rendering/Execution/SceneRenderer.cpp` 当前负责把 fullscreen 阶段写进 `CameraRenderRequest`。
|
||||
- `editor/src/Viewport/Passes/SceneViewportSelectionOutlinePass.h` 当前组合 [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md) 与 [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)。
|
||||
- `engine/src/Rendering/Pipelines/BuiltinForwardPipeline.cpp` 当前把 [BuiltinVolumetricPass](BuiltinVolumetricPass/BuiltinVolumetricPass.md) 挂进 builtin forward pass sequence。
|
||||
- `tests/Rendering/unit/test_builtin_forward_pipeline.cpp` 验证了 `VolumeField` 资源语义与布局元数据。
|
||||
- `tests/Editor/test_viewport_render_flow_utils.cpp` 验证了 Scene View render plan 如何组装 grid / selection outline / overlay pass。
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 这一层目前是 builtin、轻量、偏 editor/工具链导向的 pass 集合，还不是通用 render graph。
|
||||
- object-id 相关流程依赖单独的辅助 render target / shader resource view，而不是直接从主颜色结果反推。
|
||||
- selection outline 当前已经拆成“mask 重绘 + fullscreen compositing”两层，而不是单个对象列表后处理。
|
||||
- volumetric pass 当前依赖 `visibleVolumes`、`VolumeField` 资源绑定和 builtin cube proxy，不是独立 volume framework。
|
||||
- fullscreen pass 依赖调用方准备 `sourceColorView` 和中间表面；单个 pass 本身不管理整条阶段链。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinObjectIdPass](BuiltinObjectIdPass/BuiltinObjectIdPass.md)
|
||||
- [BuiltinObjectIdOutlinePass](BuiltinObjectIdOutlinePass/BuiltinObjectIdOutlinePass.md)
|
||||
- [BuiltinSelectionMaskPass](BuiltinSelectionMaskPass/BuiltinSelectionMaskPass.md)
|
||||
- [BuiltinSelectionOutlinePass](BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)
|
||||
- [BuiltinInfiniteGridPass](BuiltinInfiniteGridPass/BuiltinInfiniteGridPass.md)
|
||||
- [BuiltinVolumetricPass](BuiltinVolumetricPass/BuiltinVolumetricPass.md)
|
||||
- [BuiltinColorScalePostProcessPass](BuiltinColorScalePostProcessPass/BuiltinColorScalePostProcessPass.md)
|
||||
- [BuiltinFinalColorPass](BuiltinFinalColorPass/BuiltinFinalColorPass.md)
|
||||
- [BuiltinDepthStylePassBase](BuiltinDepthStylePassBase/BuiltinDepthStylePassBase.md)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# SelectionOutlinePassInputs
|
||||
|
||||
**命名空间**: `XCEngine::Rendering::Passes`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEngine/Rendering/Passes/BuiltinSelectionOutlinePass.h`
|
||||
|
||||
**描述**: selection outline pass 的输入纹理描述，指定 selection mask、depth view 及其进入 pass 前的资源状态。
|
||||
|
||||
## 字段
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| `selectionMaskTextureView` | selection mask 纹理视图 |
|
||||
| `selectionMaskState` | selection mask 当前资源状态 |
|
||||
| `depthTextureView` | 深度纹理视图 |
|
||||
| `depthTextureState` | 深度纹理当前资源状态 |
|
||||
|
||||
## 当前作用
|
||||
|
||||
- 为 `BuiltinSelectionOutlinePass::Render(...)` 提供两个输入 SRV
|
||||
- 在 surface 开启自动状态切换时，提供“切入 pass 前”的原始状态以便恢复
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](../BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)
|
||||
- [SelectionOutlineStyle](../SelectionOutlineStyle/SelectionOutlineStyle.md)
|
||||
@@ -0,0 +1,22 @@
|
||||
# SelectionOutlineStyle
|
||||
|
||||
**命名空间**: `XCEngine::Rendering::Passes`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEngine/Rendering/Passes/BuiltinSelectionOutlinePass.h`
|
||||
|
||||
**描述**: selection outline pass 的样式配置，当前控制描边颜色、像素宽度和调试遮罩模式。
|
||||
|
||||
## 默认值
|
||||
|
||||
| 字段 | 默认值 | 说明 |
|
||||
|------|------|------|
|
||||
| `outlineColor` | `Math::Color(1.0f, 0.4f, 0.0f, 1.0f)` | 默认橙色描边 |
|
||||
| `outlineWidthPixels` | `2.0f` | 描边宽度，单位像素 |
|
||||
| `debugSelectionMask` | `false` | 默认输出描边而不是直接显示 mask |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BuiltinSelectionOutlinePass](../BuiltinSelectionOutlinePass/BuiltinSelectionOutlinePass.md)
|
||||
- [SelectionOutlinePassInputs](../SelectionOutlinePassInputs/SelectionOutlinePassInputs.md)
|
||||
@@ -25,7 +25,6 @@
|
||||
- [Shader](Shader/Shader.md)
|
||||
- [Texture](Texture/Texture.md)
|
||||
- [Volume](Volume/Volume.md)
|
||||
- [Volume](Volume/Volume.md)
|
||||
|
||||
## 头文件
|
||||
|
||||
|
||||
Reference in New Issue
Block a user