refactor api documentation structure
This commit is contained in:
44
docs/api/XCEngine/Scene/SceneManager/SetActiveScene.md
Normal file
44
docs/api/XCEngine/Scene/SceneManager/SetActiveScene.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# SceneManager::SetActiveScene
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
该方法在 `XCEngine/Scene/SceneManager.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
void SetActiveScene(Scene* scene);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `scene` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
void SetActiveScene(const std::string& sceneName);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `sceneName` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Scene/SceneManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Components::SceneManager object;
|
||||
// 根据上下文补齐参数后调用 SceneManager::SetActiveScene(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](SceneManager.md)
|
||||
- [返回模块目录](../Scene.md)
|
||||
Reference in New Issue
Block a user