docs(rendering): realign api docs to module structure
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
# RenderSceneExtractor::ExtractForCamera
|
||||
|
||||
```cpp
|
||||
RenderSceneData ExtractForCamera(
|
||||
const Components::Scene& scene,
|
||||
Components::CameraComponent& camera,
|
||||
uint32_t viewportWidth,
|
||||
uint32_t viewportHeight) const;
|
||||
```
|
||||
|
||||
## 行为说明
|
||||
|
||||
和 [Extract](Extract.md) 相比,这个重载不会重新选择相机,而是要求调用方显式给出要使用的相机。
|
||||
|
||||
当前实现会:
|
||||
|
||||
1. 先检查给定相机是否可用。
|
||||
2. 相机不可用时,直接返回空的 `RenderSceneData`。
|
||||
3. 相机可用时,生成 `RenderCameraData`。
|
||||
4. 按相机的 `cullingMask` 递归提取 `visibleItems`。
|
||||
5. 对 `visibleItems` 做稳定排序,并提取主方向光。
|
||||
|
||||
## 参数
|
||||
|
||||
- `scene` - 要提取的场景。
|
||||
- `camera` - 显式指定的相机。
|
||||
- `viewportWidth` - 当前 viewport 宽度。
|
||||
- `viewportHeight` - 当前 viewport 高度。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 使用指定相机构建的 `RenderSceneData`。
|
||||
- 如果相机不可用,返回空结果。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RenderSceneExtractor](RenderSceneExtractor.md)
|
||||
- [Extract](Extract.md)
|
||||
- [SelectCamera](SelectCamera.md)
|
||||
Reference in New Issue
Block a user