docs: 更新 API 文档 - 多模块修复和完善
- audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档,新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
This commit is contained in:
37
docs/api/components/audio-source-component/get-volume.md
Normal file
37
docs/api/components/audio-source-component/get-volume.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# GetVolume
|
||||
|
||||
**所属类**: `AudioSourceComponent`
|
||||
|
||||
**头文件**: `XCEngine/Components/AudioSourceComponent.h`
|
||||
|
||||
**描述**: 获取音频源的音量。
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
float GetVolume() const;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `float` | 当前音量,范围 0.0 到 1.0 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Components/AudioSourceComponent.h>
|
||||
|
||||
using namespace XCEngine::Components;
|
||||
|
||||
void PrintVolume(AudioSourceComponent* source) {
|
||||
float volume = source->GetVolume();
|
||||
printf("Volume: %.2f\n", volume);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
|
||||
- [SetVolume](./set-volume.md) - 设置音量
|
||||
Reference in New Issue
Block a user