docs: 新增 light-component 全部方法文档及更新其他模块
- components: 新增 light-component 全部12个方法文档 - resources: 更新 audio-loader, resource-file-system 文档 - rhi: 更新 opengl/fence 文档
This commit is contained in:
37
docs/api/components/light-component/get-range.md
Normal file
37
docs/api/components/light-component/get-range.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# GetRange
|
||||
|
||||
**所属类**: `LightComponent`
|
||||
|
||||
**头文件**: `XCEngine/Components/LightComponent.h`
|
||||
|
||||
**描述**: 获取光源的作用范围(仅对点光源和聚光灯有效)。
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
float GetRange() const;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `float` | 作用范围(米),默认值为 10.0 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Components/LightComponent.h>
|
||||
|
||||
using namespace XCEngine::Components;
|
||||
|
||||
void PrintLightRange(LightComponent* light) {
|
||||
float range = light->GetRange();
|
||||
printf("Light range: %.2f meters\n", range);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [LightComponent](./light-component.md) - 光源组件
|
||||
- [SetRange](./set-range.md) - 设置作用范围
|
||||
Reference in New Issue
Block a user