docs(rendering): realign api docs to module structure
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# SceneRenderer::SceneRenderer
|
||||
|
||||
**命名空间**: `XCEngine::Rendering`
|
||||
|
||||
**类型**: `constructor`
|
||||
|
||||
**头文件**: `XCEngine/Rendering/Execution/SceneRenderer.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
SceneRenderer();
|
||||
explicit SceneRenderer(std::unique_ptr<RenderPipeline> pipeline);
|
||||
explicit SceneRenderer(std::shared_ptr<const RenderPipelineAsset> pipelineAsset);
|
||||
```
|
||||
|
||||
## 行为说明
|
||||
|
||||
构造场景级执行入口。
|
||||
|
||||
## 当前构造行为
|
||||
|
||||
- 默认构造
|
||||
使用默认构造的 `CameraRenderer`,也就是默认 builtin forward 管线接线。
|
||||
- `std::unique_ptr<RenderPipeline>` 重载
|
||||
把外部传入的 runtime pipeline 交给内部 `m_cameraRenderer`。
|
||||
- `std::shared_ptr<const RenderPipelineAsset>` 重载
|
||||
把 asset 交给内部 `m_cameraRenderer`,由它创建 runtime pipeline。
|
||||
|
||||
## 设计说明
|
||||
|
||||
`SceneRenderer` 自己不直接创建 pipeline,而是把这件事继续委托给 `CameraRenderer`。
|
||||
这样所有“主管线如何创建 / 如何回退”的规则都只在单 request 执行器里维护一份。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [SceneRenderer](SceneRenderer.md)
|
||||
- [CameraRenderer](../CameraRenderer/CameraRenderer.md)
|
||||
- [SetPipeline](SetPipeline.md)
|
||||
- [SetPipelineAsset](SetPipelineAsset.md)
|
||||
Reference in New Issue
Block a user