Files
XCEngine/docs/api/audio/hrtf/hrtf.md
ssdfasd 161a0896d5 docs: 添加 Audio 模块和 Components 模块 API 文档
- 新增 Audio 模块文档 (54 个文件)
  - AudioSystem 单例类及 20 个方法页
  - AudioMixer 混音器类及 11 个方法页
  - IAudioBackend、IAudioEffect 接口
  - FFTFilter、Reverbation、Equalizer、HRTF 效果类
  - WASAPIBackend Windows 后端
  - AudioConfig、Audio3DParams 等结构体
  - 9 个枚举类型文档
- 新增 Components 模块文档 (3 个文件)
  - AudioSourceComponent 音频源组件
  - AudioListenerComponent 音频监听器组件
- 更新 docs/api/main.md 添加模块导航
2026-03-22 01:56:16 +08:00

56 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# HRTF
**命名空间**: `XCEngine::Audio`
**类型**: `class`
**头文件**: `XCEngine/Audio/HRTF.h`
**描述**: 基于头部相关传输函数Head-Related Transfer Function的 3D 空间音频处理器。
## 概述
HRTF 实现了基于头部相关传输函数Head-Related Transfer Function的 3D 空间音频算法。它通过计算声音的耳间时间差ITD、耳间电平差ILD和耳廓线索Pinna Cues在双耳耳机或扬声器上重现逼真的 3D 空间音效。支持多普勒效应、交叉馈送Cross-feed调节和质量级别设置。
## 公共方法
| 方法 | 描述 |
|------|------|
| [`HRTF`](constructor.md) | 构造函数 |
| [`~HRTF`](destructor.md) | 析构函数 |
| [`ProcessAudio`](process-audio.md) | 处理 3D 空间化音频 |
| [`SetEnabled`](set-enabled.md) | 设置启用状态 |
| [`IsEnabled`](is-enabled.md) | 检查启用状态 |
| [`SetHRTFEnabled`](set-hrtf-enabled.md) | 设置 HRTF 处理启用状态 |
| [`IsHRTFEnabled`](is-hrtf-enabled.md) | 检查 HRTF 处理启用状态 |
| [`SetQualityLevel`](set-quality-level.md) | 设置质量级别 |
| [`GetQualityLevel`](get-quality-level.md) | 获取质量级别 |
| [`SetCrossFeed`](set-cross-feed.md) | 设置交叉馈送值 |
| [`GetCrossFeed`](get-cross-feed.md) | 获取交叉馈送值 |
| [`SetDopplerShiftEnabled`](set-doppler-shift-enabled.md) | 设置多普勒效应启用状态 |
| [`IsDopplerShiftEnabled`](is-doppler-shift-enabled.md) | 检查多普勒效应启用状态 |
| [`SetSpeedOfSound`](set-speed-of-sound.md) | 设置声速 |
| [`GetSpeedOfSound`](get-speed-of-sound.md) | 获取声速 |
## 使用示例
```cpp
#include <XCEngine/Audio/HRTF.h>
using namespace XCEngine::Audio;
void SetupHRTF() {
HRTF* hrtf = new HRTF();
hrtf->SetHRTFEnabled(true);
hrtf->SetQualityLevel(2);
hrtf->SetCrossFeed(0.2f);
hrtf->SetDopplerShiftEnabled(true);
hrtf->SetSpeedOfSound(343.0f);
}
```
## 相关文档
- [Audio 模块总览](../audio.md) - Audio 模块总览
- [HRTFParams](../hrtf-params/hrtf-params.md) - HRTF 参数结构体