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:
43
docs/api/components/audio-source-component/set-pitch.md
Normal file
43
docs/api/components/audio-source-component/set-pitch.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# SetPitch
|
||||
|
||||
**所属类**: `AudioSourceComponent`
|
||||
|
||||
**头文件**: `XCEngine/Components/AudioSourceComponent.h`
|
||||
|
||||
**描述**: 设置音频源的音高。
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
void SetPitch(float pitch);
|
||||
```
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `pitch` | `float` | 音高,0.5 表示半速,1.0 表示正常速度,2.0 表示双倍速度 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Components/AudioSourceComponent.h>
|
||||
|
||||
using namespace XCEngine::Components;
|
||||
|
||||
void SetupPitch(AudioSourceComponent* source) {
|
||||
// 正常音高
|
||||
source->SetPitch(1.0f);
|
||||
|
||||
// 低八度
|
||||
source->SetPitch(0.5f);
|
||||
|
||||
// 高八度
|
||||
source->SetPitch(2.0f);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
|
||||
- [GetPitch](./get-pitch.md) - 获取音高
|
||||
Reference in New Issue
Block a user