docs: 更新 resources, rhi, scene 模块及新增 camera-component 方法文档
- resources: 更新 asyncloader, audioclip, mesh-import-settings, texture-loader 文档 - rhi: 更新 opengl render-target-view 文档 - components: 新增 camera-component 全部方法文档 (15个文件)
This commit is contained in:
38
docs/api/components/camera-component/is-primary.md
Normal file
38
docs/api/components/camera-component/is-primary.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# IsPrimary
|
||||
|
||||
**所属类**: `CameraComponent`
|
||||
|
||||
**头文件**: `XCEngine/Components/CameraComponent.h`
|
||||
|
||||
**描述**: 检查摄像机是否为主摄像机。
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
bool IsPrimary() const;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `bool` | true 表示为主摄像机,false 表示非主摄像机 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Components/CameraComponent.h>
|
||||
|
||||
using namespace XCEngine::Components;
|
||||
|
||||
void CheckPrimaryCamera(CameraComponent* camera) {
|
||||
if (camera->IsPrimary()) {
|
||||
printf("This is the primary camera\n");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [CameraComponent](camera-component.md) - 摄像机组件
|
||||
- [SetPrimary](set-primary.md) - 设置为主摄像机
|
||||
Reference in New Issue
Block a user