xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor api documentation structure

Browse Source
This commit is contained in:
ssdfasd
2026-03-26 16:45:24 +08:00
parent 45842e961e
commit 6244b586bb
4389 changed files with 80504 additions and 69241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

575
docs/api-skill.md
View File

@@ -1,450 +1,277 @@
# XCEngine API 文档编写与校验 Skill # XCEngine API Documentation Skill
## 用途 ## 目标
根据 XCEngine C++ 引擎源码生成符合规范的 API 文档，并进行格式校验和查漏补缺。 本规范用于为 `XCEngine` 生成和维护一套唯一的 canonical API 文档。
在开始编写任何文档之前，必须先完整阅读并深刻理解对应的源码上下文——包括设计目的、 硬性要求：
实现细节、边界条件、线程安全约定、与其他模块的依赖关系等。切忌在未读懂源码的情况下
仅凭方法签名或猜测来编写文档。
--- 1. `docs/api/XCEngine/**` 必须与 `engine/include/XCEngine/**` 严格平行。
2. 模块、子模块、类型、方法的命名必须稳定并贴近源码符号名。
3. 不保留第二套正式文档树。历史文档只允许作为迁移过程中的临时材料，迁移完成后必须删除。
## 文档目录结构 在编写任何 API 文档之前，必须先阅读对应头文件与相关实现，理解职责、边界、生命周期、线程语义、错误条件和依赖关系。禁止只根据函数名猜测含义。
``` ## Canonical 目录结构
```text
docs/api/ docs/api/
├── main.md # 总索引 ├── main.md
├── {module}/ ├── XCEngine/
│ ├── {module}.md # 模块总览页 │ ├── XCEngine.md
│ ├── {class}/ │ ├── Debug/
│ │ ├── {class}.md # 类/结构体/枚举总览页 │ │ ├── Debug.md
│ │ ├── {method}.md # 方法详情页 │ │ ├── Logger/
│ │ └── ... │ │ │ ├── Logger.md
│ │ │ ├── Log.md
│ │ │ ├── SetLevel.md
│ │ │ ├── Constructor.md
│ │ │ └── Destructor.md
│ │ └── RenderDocCapture/
│ │ ├── RenderDocCapture.md
│ │ └── TriggerCapture.md
│ ├── Core/
│ │ ├── Core.md
│ │ ├── Asset/
│ │ │ ├── Asset.md
│ │ │ └── ResourceManager/
│ │ │ ├── ResourceManager.md
│ │ │ └── Load.md
│ │ └── Math/
│ │ └── Math.md
│ └── ... │ └── ...
└── ... ├── _meta/
└── _tools/
``` ```
**命名规则：** ## 强制命名规则
- 模块总览：`{module}/{module}.md`（如 `threading/threading.md`） ### 1. 目录总览页
- 类/结构体文件夹：`{class-name}/`（小写，如 `task-group/`）
- 类总览页：`{class-name}/{class-name}.md`
- 方法详情页：`{class-name}/{method-name}.md`
- 构造函数/析构函数：`constructor.md`、`destructor.md`、`~typename.md`
- 运算符重载：`operator-assign.md`、`operator-plus.md`、`operator-subscript.md`
- 枚举详情页（单独文件夹时）：`{enum-name}/{enum-name}.md`
--- - 根目录总览页必须是 `docs/api/XCEngine/XCEngine.md`
- 模块总览页必须使用 `{ModuleName}.md`
- 子模块总览页必须使用 `{SubmoduleName}.md`
- canonical 目录下禁止使用 `README.md` 作为模块或子模块总览页
## 页面类型与模板 示例：
### 1. 模块总览页 - `docs/api/XCEngine/Debug/Debug.md`
- `docs/api/XCEngine/Core/Core.md`
- `docs/api/XCEngine/Core/Asset/Asset.md`
- `docs/api/XCEngine/RHI/D3D12/D3D12.md`
### 2. 类型目录
- 每个 public 类型或以 header 为单位的主声明，都必须是一个独立文件夹
- 文件夹名必须与源码中的类型名或 header stem 保持一致
- 保留原始大小写
示例：
- `docs/api/XCEngine/Debug/Logger/`
- `docs/api/XCEngine/Core/Asset/ResourceManager/`
- `docs/api/XCEngine/RHI/D3D12/D3D12Device/`
### 3. 类型总览页
- 类型总览页固定为 `{TypeName}/{TypeName}.md`
- 不允许把类型总览页直接平铺在模块目录下
### 4. 方法详情页
- 方法详情页必须放在所属类型文件夹内
- 方法页文件名优先使用原函数名
- 保留 PascalCase / camelCase / 全大写缩写
- 禁止改成 lowercase kebab-case
- 同名重载共用一个方法页
示例：
- `Get.md`
- `CreateBuffer.md`
- `SetRenderTarget.md`
- `LoadSceneAsync.md`
- `GetCPUHandle.md`
### 5. 特殊方法命名
- 构造函数使用 `Constructor.md`
- 析构函数使用 `Destructor.md`
- 运算符重载使用可读的 PascalCase 名称
推荐映射：
- `operator=` -> `OperatorAssign.md`
- `operator+=` -> `OperatorPlusAssign.md`
- `operator[]` -> `OperatorSubscript.md`
- `operator()` -> `OperatorCall.md`
- `operator bool` -> `OperatorBool.md`
## 页面职责
### 1. 目录总览页
负责：
- 说明模块或子模块的职责边界
- 列出直接子目录
- 列出当前目录下的 public headers 对应类型入口
- 提供父级目录和 `docs/api/main.md` 的导航
不负责：
- 展开详细方法级说明
- 复制头文件全部声明
- 保留迁移说明、旧入口跳转或双轨文档提示
### 2. 类型总览页
负责：
- 标识命名空间、类型、头文件、职责
- 给出声明概览
- 列出公开字段、枚举值或公开方法
- 作为该类型所有方法详情页的稳定入口
### 3. 方法详情页
负责：
- 给出准确签名
- 按重载分节
- 说明参数、返回值、生命周期、线程语义和关键约束
- 给出最小但可信的示例
## 推荐页面模板
### 1. 目录总览页模板
```markdown ```markdown
# {ModuleName} 模块概览 # {DirName}
**命名空间**: `{namespace}` **命名空间**: `{Namespace}`
**类型**: `module` **类型**: `module` / `submodule` / `module-root`
**描述**: {模块一句话描述} **描述**: {一句话说明当前目录职责}
## 概述 ## 概览
{模块功能详细介绍} {说明该目录在整个引擎中的职责边界、使用场景和与相邻模块的关系}
## 模块内容 ## 子目录
### {子分类名} - [ChildA](ChildA/ChildA.md)
- [ChildB](ChildB/ChildB.md)
| 组件 | 文件 | 描述 | ## 头文件
|------|------|------|
| [{ComponentName}](component/component.md) | `{Header.h}` | {描述} |
...
## {可选：对标/对比表格} - [TypeA](TypeA/TypeA.md) - `TypeA.h`
- [TypeB](TypeB/TypeB.md) - `TypeB.h`
| 选项 | 适用场景 | 特点 |
|------|----------|------|
| `Foo` | 场景A | 特点X |
## 使用示例
```cpp
{完整可运行代码}
```
## 相关文档 ## 相关文档
- [{DocName}](../{module}/{doc}.md) - {描述} - [上级目录](../{ParentDir}.md)
- [API 总索引](../../main.md)
``` ```
### 2. 类总览页 ### 2. 类型总览页模板
```markdown ```markdown
# {ClassName} # {TypeName}
**命名空间**: `{namespace}` **命名空间**: `{Namespace}`
**类型**: `class` / `class (abstract)` / `class (singleton)` **类型**: `class` / `class (abstract)` / `class (singleton)` / `struct` / `enum class`
**头文件**: `XCEngine/Path/Header.h` **头文件**: `XCEngine/.../{Header}.h`
**描述**: {一句话功能描述} **描述**: {一句话说明}
## 概述 ## 概览
{类的详细介绍} {描述该类型的职责、拥有关系、状态约束、典型使用方式}
## {可选章节} ## 声明概览
### 类型别名 | 声明 | 类型 | 说明 |
| 别名 | 类型 | 描述 |
|------|------|------| |------|------|------|
| `SizeType` | `size_t` | 大小类型 | | `{TypeName}` | `class` | {说明} |
### 常量
| 常量 | 值 | 描述 |
|------|-----|------|
| `static constexpr SizeType npos` | `-1` | 无效位置标识 |
## 公共方法 ## 公共方法
| 方法 | 描述 | | 方法 | 描述 |
|------|------| |------|------|
| [{MethodName}](method-name.md) | {描述} | | [Initialize](Initialize.md) | {描述} |
| `virtual ~ClassName()` | 虚析构函数 | | [Shutdown](Shutdown.md) | {描述} |
## 受保护方法（如有）
| 方法 | 描述 |
|------|------|
| `ClassName()` | 默认构造函数 |
## 使用示例
```cpp
{完整可运行代码}
```
## 相关文档 ## 相关文档
- [{RelatedClass}](../module/class.md) - {描述} - [当前目录](../{DirName}.md)
``` ```
### 3. Struct 总览页 ### 3. 方法详情页模板
```markdown ```markdown
# {StructName} # {TypeName}::{MethodName}
**命名空间**: `{namespace}` {一句话说明方法职责}
**类型**: `struct`
**头文件**: `XCEngine/Path/Header.h`
**描述**: {一句话功能描述}
## 结构体成员
| 成员 | 类型 | 描述 | 默认值 |
|------|------|------|--------|
| [{memberName}](membername.md) | `type` | {描述} | {默认值} |
## 使用示例
```cpp ```cpp
{完整可运行代码} {完整签名}
``` ```
## 相关文档 {方法行为说明，包括前置条件、后置条件、副作用和失败语义}
- [{RelatedDoc}](../module/doc.md) - {描述} **参数**
```
### 4. Enum 总览页
```markdown
# {EnumName}
**命名空间**: `{namespace}`
**类型**: `enum class`
**头文件**: `XCEngine/Path/Header.h`
## 概述
{枚举用途描述}
## 枚举值
| 枚举值 | 数值 | 描述 |
|--------|------|------|
| `ValueName` | {N} | {描述} |
...
## 使用示例
```cpp
{完整可运行代码}
```
## 相关文档
- [{RelatedDoc}](../module/doc.md) - {描述}
```
### 5. 方法详情页（单重载）
```markdown
# {ClassName}::{MethodName}
{一句话描述方法功能}
```cpp
{完整方法签名}
```
{详细描述，包括设计目的和使用场景}
**参数：**
- `paramName` - {参数描述}
**返回：** {返回值类型} - {返回值含义}
**线程安全：** ✅ / ❌ {可选说明}
**复杂度：** O(n) {可选}
**注意：** {可选，重要警告或注意事项}
**示例：**
```cpp
{完整可运行代码}
```
## 相关文档
- [{ClassName} 总览](class-name.md)
- [{RelatedMethod}](related-method.md)
```
### 6. 方法详情页（多重载）
当方法有多个重载时，使用 `## 重载 N:` 分节：
```markdown
# {ClassName}::{MethodName}
{一句话描述方法功能}
## 重载 1: {简短描述}
```cpp
{签名1}
```
{描述}
**参数：**
- `param` - {描述} - `param` - {描述}
**返回：** {类型} - {含义} **返回**
- `{Type}` - {描述}
**复杂度：** O(n) **线程语义**
- {线程安全 / 只能主线程 / 调用方同步等}
## 重载 2: {简短描述} **示例**
```cpp ```cpp
{签名2} {最小可信示例}
```
...
**线程安全：** ✅
**示例：**
```cpp
{完整可运行代码}
``` ```
## 相关文档 ## 相关文档
- [{ClassName} 总览](class-name.md) - [返回类型总览]({TypeName}.md)
- [返回模块目录](../{DirName}.md)
``` ```
--- ## 文风与质量要求
## 元信息字段规范 - 使用工程化、可审阅、可维护的描述，不写空话
- 描述职责边界，而不是复述函数名
- 线程、生命周期、资源所有权、错误条件必须明确
- 示例必须与当前 public API 一致，不允许伪代码式胡写
- 信息应放在正确层级，避免模块页和类型页职责混淆
- 禁止生成双轨入口或保留旧目录跳转
| 字段 | 必需 | 适用页面 | 说明 | ## 重构与生成流程
|------|------|----------|------|
| `**命名空间**` | 是 | 所有 | C++ 命名空间 |
| `**类型**` | 是 | 所有 | `class`、`struct`、`enum class`、`module` 等；class 可加修饰如 `(abstract)`、`(singleton)` |
| `**描述**` | 是 | 所有 | 一句话功能描述 |
| `**头文件**` | 是 | 类/struct/enum | 相对路径形式，如 `XCEngine/Threading/Task.h` |
--- 1. 扫描 `engine/include/XCEngine/**`
2. 建立与源码平行的 `docs/api/XCEngine/**` 目录树
3. 为每个源码目录生成 `{DirName}.md` 目录总览页
4. 为每个 public header 生成 `{TypeName}/{TypeName}.md`
5. 为每个公开方法生成 `{TypeName}/{MethodName}.md`
6. 清理旧的 lowercase kebab-case 方法页和旧的 flat header 页面
7. 删除迁移完成后的历史文档
8. 审计链接、头文件引用覆盖率和目录索引完整性
## 必需章节规范 ## 验收清单
### 模块总览页 - `docs/api/XCEngine/**` 与 `engine/include/XCEngine/**` 目录结构平行
- canonical 目录下没有模块级 `README.md`
1. `## 概述` — 模块功能介绍 - 每个类型都是一个独立文件夹
2. `## 模块内容` — 分类表格（含组件名、文件、描述三列） - 每个类型总览页都是 `{TypeName}/{TypeName}.md`
3. `## 使用示例` — 完整代码 - 方法页文件名使用原函数名或规范化运算符名
4. `## 相关文档` — 交叉引用 - `docs/api/main.md` 指向 `docs/api/XCEngine/XCEngine.md`
- 所有 canonical `.md` 链接可解析
### 类总览页 - 所有 public headers 都有对应 canonical 文档入口
- 仓库中不存在第二套正式 API 文档树
1. `## 概述` — 类功能介绍
2. `## 公共方法` — 方法列表（纯虚方法加标注 `(pure virtual)`）
3. `## 受保护方法` — 如有
4. `## 使用示例` — 完整代码
5. `## 相关文档` — 交叉引用
### Struct 总览页
1. `## 结构体成员` — 成员表格（含类型、描述、默认值三列）
2. `## 使用示例` — 完整代码
3. `## 相关文档` — 交叉引用
### Enum 总览页
1. `## 枚举值` — 枚举值表格（含枚举值、数值、描述三列）
2. `## 使用示例` — 完整代码
3. `## 相关文档` — 交叉引用
### 方法详情页
1. **方法签名** — 完整 `cpp` 代码块
2. **详细描述** — 语义和使用场景
3. **参数列表** — 每个参数的含义
4. **返回值** — 类型和含义
5. **示例代码** — 完整可运行代码
6. **相关文档** — 返回类总览的链接
---
## 链接规范
- 同一类文件夹内跳转：`[MethodName](method-name.md)`
- 指向类总览：`[ClassName 总览](class-name.md)`
- 指向模块总览：`[../module.md](../module.md)` 或 `[模块名](../module.md)`
- 跨模块跳转：`[{DocName}](../module/class.md)`
- 链接文本使用中文（如"返回类总览"）而非英文
---
## 特殊章节
### Singleton 类
Singleton 类在 `## 公共方法` 后可加 `## 单例访问` 章节：
```markdown
## 单例访问
| 方法 | 描述 |
|------|------|
| `static ClassName& Get()` | 获取单例实例 |
```
### std::hash 特化
String 等需要 hash 的类，在方法列表后加：
```markdown
## std::hash 特化
```cpp
namespace std {
template<>
struct hash<XCEngine::Containers::String> {
size_t operator()(const XCEngine::Containers::String& str) const noexcept;
};
}
```
{描述 hash 算法细节}
```
### 构造函数详细表
某些类（如 ConsoleLogSink）在类总览页末尾用表格记录构造函数参数默认值：
```markdown
## 构造函数详细
| 属性 | 值 |
|------|-----|
| 默认 `m_colorOutput` | `true` |
```
---
## 代码示例规范
- 语言标签：`cpp`
- 包含必要的 `#include`
- 示例完整可运行（不是代码片段）
- 代码注释使用中文
---
## 线程安全标注
- `✅` — 线程安全
- `❌` — 非线程安全
- 可附加括号说明：`✅ (内部使用 mutex 保护)`
---
## 文档一致性检查
生成或修改文档时，需检查：
1. **元信息完整性** — 每页都有命名空间、类型、描述、头文件（类/struct/enum）
2. **链接有效性** — 所有相对链接指向的文件确实存在
3. **内容无重复** — 同一页面中不要出现重复的描述、参数、示例等
4. **类型匹配** — `**类型**` 字段与实际 C++ 类型一致
5. **枚举数值** — enum 页面包含数值列
6. **默认值** — struct 页面成员表格包含默认值列
7. **命名一致** — 页面文件名与 H1 标题一致
---
## 生成流程
> **核心原则：在动手写文档之前，必须先完整阅读并深刻理解源码上下文。**
1. **阅读源码**：完整阅读目标类的头文件（.h）和实现文件（.cpp），理解设计意图、数据成员、
工作流程、边界条件、线程安全约定、与其他模块的依赖关系。不要只看签名就写文档。
2. **扫描提取**：在充分理解的基础上，系统性提取方法签名、成员变量、枚举值、文档注释等信息。
3. **创建结构**：为每个类创建文件夹，生成类总览页和方法详情页。
4. **检查一致性**：运行链接检查、字段完整性检查。
5. **补充缺失**：对照源码，检查现有文档是否完整，如有缺失的 .md 文件（类总览页、方法详情页等）
必须自行创建；如现有文档中缺少示例、枚举值说明、参数描述等内容，也要自行补充完整，不要留空。
6. **输出报告**：列出生成文件列表、缺失内容、发现的问题。
---
## 使用示例
用户输入：
```
完善 docs/api 文档，检查并修复错误
```
AI 执行：
1. 扫描指定源码目录
2. 识别所有头文件中的 class/struct/enum
3. 对比现有文档，找出缺失文件和错误引用
4. 生成或修复 Markdown 文档
5. 输出生成报告和问题列表

30
docs/api/XCEngine/Audio/Audio.md Normal file
View File

@@ -0,0 +1,30 @@
# Audio
**命名空间**: `XCEngine::Audio`
**类型**: `module`
**描述**: 音频系统、混音器、效果器与后端接口。
## 概览
该目录与 `XCEngine/Audio` 对应的 public headers 保持平行，用于承载唯一的 canonical API 文档入口。
## 头文件
- [AudioConfig](AudioConfig/AudioConfig.md) - `AudioConfig.h`
- [AudioMixer](AudioMixer/AudioMixer.md) - `AudioMixer.h`
- [AudioSystem](AudioSystem/AudioSystem.md) - `AudioSystem.h`
- [AudioTypes](AudioTypes/AudioTypes.md) - `AudioTypes.h`
- [Equalizer](Equalizer/Equalizer.md) - `Equalizer.h`
- [FFTFilter](FFTFilter/FFTFilter.md) - `FFTFilter.h`
- [HRTF](HRTF/HRTF.md) - `HRTF.h`
- [IAudioBackend](IAudioBackend/IAudioBackend.md) - `IAudioBackend.h`
- [IAudioEffect](IAudioEffect/IAudioEffect.md) - `IAudioEffect.h`
- [Reverbation](Reverbation/Reverbation.md) - `Reverbation.h`
- [WindowsAudioBackend](WindowsAudioBackend/WindowsAudioBackend.md) - `WindowsAudioBackend.h`
## 相关文档
- [上级目录](../XCEngine.md)
- [API 总索引](../../main.md)

35
docs/api/XCEngine/Audio/AudioConfig/AudioConfig.md Normal file
View File

@@ -0,0 +1,35 @@
# AudioConfig
**命名空间**: `XCEngine::Audio`
**类型**: `struct`
**头文件**: `XCEngine/Audio/AudioConfig.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioConfig` public API。
## 概述
`AudioConfig.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `AudioConfig` | `struct` | 头文件中的公开声明。 |
## 结构体成员
| 成员 | 类型 | 描述 | 默认值 |
|------|------|------|--------|
| `sampleRate` | `uint32_t` | 结构体公开字段。 | `48000` |
| `channels` | `uint16` | 结构体公开字段。 | `2` |
| `bitsPerSample` | `uint16` | 结构体公开字段。 | `16` |
| `speakerMode` | `SpeakerMode` | 结构体公开字段。 | `SpeakerMode::Stereo` |
| `bufferSize` | `uint32` | 结构体公开字段。 | `8192` |
| `bufferCount` | `uint32` | 结构体公开字段。 | `2` |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

31
docs/api/XCEngine/Audio/AudioMixer/AddEffect.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::AddEffect
添加元素或建立关联。
```cpp
void AddEffect(IAudioEffect* effect);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `effect` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::AddEffect(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

45
docs/api/XCEngine/Audio/AudioMixer/AudioMixer.md Normal file
View File

@@ -0,0 +1,45 @@
# AudioMixer
**命名空间**: `XCEngine::Audio`
**类型**: `class`
**头文件**: `XCEngine/Audio/AudioMixer.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioMixer` public API。
## 概述
`AudioMixer.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `AudioMixer` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [AudioMixer()](Constructor.md) | 构造对象。 |
| [~AudioMixer()](Destructor.md) | 销毁对象并释放相关资源。 |
| [SetVolume](SetVolume.md) | 设置相关状态或配置。 |
| [GetVolume](GetVolume.md) | 获取相关状态或对象。 |
| [SetMute](SetMute.md) | 设置相关状态或配置。 |
| [IsMute](IsMute.md) | 查询当前状态。 |
| [AddEffect](AddEffect.md) | 添加元素或建立关联。 |
| [RemoveEffect](RemoveEffect.md) | 移除元素或解除关联。 |
| [ClearEffects](ClearEffects.md) | 清空内部数据。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [SetOutputMixer](SetOutputMixer.md) | 设置相关状态或配置。 |
| [GetOutputMixer](GetOutputMixer.md) | 获取相关状态或对象。 |
| [Set3DParams](Set3DParams.md) | 设置相关状态或配置。 |
| [Get3DParams](Get3DParams.md) | 获取相关状态或对象。 |
| [SetChannelVolume](SetChannelVolume.md) | 设置相关状态或配置。 |
| [GetChannelVolume](GetChannelVolume.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

30
docs/api/XCEngine/Audio/AudioMixer/ClearEffects.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioMixer::ClearEffects
清空内部数据。
```cpp
void ClearEffects();
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::ClearEffects(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

28
docs/api/XCEngine/Audio/AudioMixer/Constructor.md Normal file
View File

@@ -0,0 +1,28 @@
# AudioMixer::AudioMixer()
构造对象。
```cpp
AudioMixer();
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

29
docs/api/XCEngine/Audio/AudioMixer/Destructor.md Normal file
View File

@@ -0,0 +1,29 @@
# AudioMixer::~AudioMixer()
销毁对象并释放相关资源。
```cpp
~AudioMixer();
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioMixer/Get3DParams.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioMixer::Get3DParams
获取相关状态或对象。
```cpp
const Audio3DParams& Get3DParams() const;
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const Audio3DParams&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::Get3DParams(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/GetChannelVolume.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::GetChannelVolume
获取相关状态或对象。
```cpp
float GetChannelVolume(AudioChannel channel) const;
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `channel` - 参数语义详见头文件声明。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::GetChannelVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioMixer/GetOutputMixer.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioMixer::GetOutputMixer
获取相关状态或对象。
```cpp
AudioMixer* GetOutputMixer() const;
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `AudioMixer*` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::GetOutputMixer(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioMixer/GetVolume.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioMixer::GetVolume
获取相关状态或对象。
```cpp
float GetVolume() const;
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::GetVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioMixer/IsMute.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioMixer::IsMute
查询当前状态。
```cpp
bool IsMute() const;
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::IsMute(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

33
docs/api/XCEngine/Audio/AudioMixer/ProcessAudio.md Normal file
View File

@@ -0,0 +1,33 @@
# AudioMixer::ProcessAudio
公开方法，详见头文件声明。
```cpp
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `sampleCount` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/RemoveEffect.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::RemoveEffect
移除元素或解除关联。
```cpp
void RemoveEffect(IAudioEffect* effect);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `effect` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::RemoveEffect(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/Set3DParams.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::Set3DParams
设置相关状态或配置。
```cpp
void Set3DParams(const Audio3DParams& params);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `params` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::Set3DParams(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

32
docs/api/XCEngine/Audio/AudioMixer/SetChannelVolume.md Normal file
View File

@@ -0,0 +1,32 @@
# AudioMixer::SetChannelVolume
设置相关状态或配置。
```cpp
void SetChannelVolume(AudioChannel channel, float volume);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `channel` - 参数语义详见头文件声明。
- `volume` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::SetChannelVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/SetMute.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::SetMute
设置相关状态或配置。
```cpp
void SetMute(bool mute);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `mute` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::SetMute(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/SetOutputMixer.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::SetOutputMixer
设置相关状态或配置。
```cpp
void SetOutputMixer(AudioMixer* mixer);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `mixer` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::SetOutputMixer(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioMixer/SetVolume.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioMixer::SetVolume
设置相关状态或配置。
```cpp
void SetVolume(float volume);
```
该方法声明于 `XCEngine/Audio/AudioMixer.h`，当前页面用于固定 `AudioMixer` 类目录下的方法级 canonical 路径。
**参数：**
- `volume` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioMixer.h>
void Example() {
XCEngine::Audio::AudioMixer object;
// 根据上下文补齐参数后调用 AudioMixer::SetVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioMixer.md)
- [返回模块目录](../Audio.md)

51
docs/api/XCEngine/Audio/AudioSystem/AudioSystem.md Normal file
View File

@@ -0,0 +1,51 @@
# AudioSystem
**命名空间**: `XCEngine::Audio`
**类型**: `class (singleton)`
**头文件**: `XCEngine/Audio/AudioSystem.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioSystem` public API。
## 概述
`AudioSystem.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `AudioSystem` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [Get](Get.md) | 获取相关状态或对象。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [Update](Update.md) | 更新运行时状态。 |
| [SetBackend](SetBackend.md) | 设置相关状态或配置。 |
| [GetBackend](GetBackend.md) | 获取相关状态或对象。 |
| [GetCurrentDevice](GetCurrentDevice.md) | 获取相关状态或对象。 |
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
| [GetAvailableDevices](GetAvailableDevices.md) | 获取相关状态或对象。 |
| [GetMasterVolume](GetMasterVolume.md) | 获取相关状态或对象。 |
| [SetMasterVolume](SetMasterVolume.md) | 设置相关状态或配置。 |
| [IsMuted](IsMuted.md) | 查询当前状态。 |
| [SetMuted](SetMuted.md) | 设置相关状态或配置。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [SetListenerTransform](SetListenerTransform.md) | 设置相关状态或配置。 |
| [SetListenerVelocity](SetListenerVelocity.md) | 设置相关状态或配置。 |
| [GetListenerPosition](GetListenerPosition.md) | 获取相关状态或对象。 |
| [GetListenerRotation](GetListenerRotation.md) | 获取相关状态或对象。 |
| [GetListenerVelocity](GetListenerVelocity.md) | 获取相关状态或对象。 |
| [RegisterSource](RegisterSource.md) | 注册对象、回调或映射。 |
| [UnregisterSource](UnregisterSource.md) | 取消注册对象、回调或映射。 |
| [GetStats](GetStats.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

29
docs/api/XCEngine/Audio/AudioSystem/Get.md Normal file
View File

@@ -0,0 +1,29 @@
# AudioSystem::Get
获取相关状态或对象。
```cpp
static AudioSystem& Get();
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `AudioSystem&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
auto& instance = XCEngine::Audio::AudioSystem::Get();
(void)instance;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/GetAvailableDevices.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::GetAvailableDevices
获取相关状态或对象。
```cpp
void GetAvailableDevices(std::vector<std::string>& devices);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `devices` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetAvailableDevices(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetBackend.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetBackend
获取相关状态或对象。
```cpp
IAudioBackend* GetBackend() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `IAudioBackend*` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetBackend(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetCurrentDevice.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetCurrentDevice
获取相关状态或对象。
```cpp
std::string GetCurrentDevice() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `std::string` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetCurrentDevice(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetListenerPosition.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetListenerPosition
获取相关状态或对象。
```cpp
const Math::Vector3& GetListenerPosition() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const Math::Vector3&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetListenerPosition(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetListenerRotation.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetListenerRotation
获取相关状态或对象。
```cpp
const Math::Quaternion& GetListenerRotation() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const Math::Quaternion&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetListenerRotation(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetListenerVelocity.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetListenerVelocity
获取相关状态或对象。
```cpp
const Math::Vector3& GetListenerVelocity() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const Math::Vector3&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetListenerVelocity(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetMasterVolume.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetMasterVolume
获取相关状态或对象。
```cpp
float GetMasterVolume() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetMasterVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/GetStats.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::GetStats
获取相关状态或对象。
```cpp
const Stats& GetStats() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const Stats&` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::GetStats(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/Initialize.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::Initialize
初始化内部状态。
```cpp
void Initialize(const AudioConfig& config);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `config` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::Initialize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/IsMuted.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::IsMuted
查询当前状态。
```cpp
bool IsMuted() const;
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::IsMuted(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

33
docs/api/XCEngine/Audio/AudioSystem/ProcessAudio.md Normal file
View File

@@ -0,0 +1,33 @@
# AudioSystem::ProcessAudio
公开方法，详见头文件声明。
```cpp
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `sampleCount` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/RegisterSource.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::RegisterSource
注册对象、回调或映射。
```cpp
void RegisterSource(Components::AudioSourceComponent* source);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `source` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::RegisterSource(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/SetBackend.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::SetBackend
设置相关状态或配置。
```cpp
void SetBackend(std::unique_ptr<IAudioBackend> backend);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `backend` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetBackend(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/SetDevice.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::SetDevice
设置相关状态或配置。
```cpp
void SetDevice(const std::string& deviceName);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `deviceName` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetDevice(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

32
docs/api/XCEngine/Audio/AudioSystem/SetListenerTransform.md Normal file
View File

@@ -0,0 +1,32 @@
# AudioSystem::SetListenerTransform
设置相关状态或配置。
```cpp
void SetListenerTransform(const Math::Vector3& position, const Math::Quaternion& rotation);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `position` - 参数语义详见头文件声明。
- `rotation` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetListenerTransform(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/SetListenerVelocity.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::SetListenerVelocity
设置相关状态或配置。
```cpp
void SetListenerVelocity(const Math::Vector3& velocity);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `velocity` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetListenerVelocity(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/SetMasterVolume.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::SetMasterVolume
设置相关状态或配置。
```cpp
void SetMasterVolume(float volume);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `volume` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetMasterVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/SetMuted.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::SetMuted
设置相关状态或配置。
```cpp
void SetMuted(bool muted);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `muted` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::SetMuted(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/AudioSystem/Shutdown.md Normal file
View File

@@ -0,0 +1,30 @@
# AudioSystem::Shutdown
关闭并清理内部状态。
```cpp
void Shutdown();
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::Shutdown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/UnregisterSource.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::UnregisterSource
取消注册对象、回调或映射。
```cpp
void UnregisterSource(Components::AudioSourceComponent* source);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `source` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::UnregisterSource(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/AudioSystem/Update.md Normal file
View File

@@ -0,0 +1,31 @@
# AudioSystem::Update
更新运行时状态。
```cpp
void Update(float deltaTime);
```
该方法声明于 `XCEngine/Audio/AudioSystem.h`，当前页面用于固定 `AudioSystem` 类目录下的方法级 canonical 路径。
**参数：**
- `deltaTime` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/AudioSystem.h>
void Example() {
XCEngine::Audio::AudioSystem object;
// 根据上下文补齐参数后调用 AudioSystem::Update(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](AudioSystem.md)
- [返回模块目录](../Audio.md)

43
docs/api/XCEngine/Audio/AudioTypes/AudioTypes.md Normal file
View File

@@ -0,0 +1,43 @@
# AudioTypes
**命名空间**: `XCEngine::Audio`
**类型**: `enum class`
**头文件**: `XCEngine/Audio/AudioTypes.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `AudioTypes` public API。
## 概述
`AudioTypes.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `AudioResourceType` | `enum class` | 头文件中的公开声明。 |
| `AudioLoadState` | `enum class` | 头文件中的公开声明。 |
| `AudioFormat` | `enum class` | 头文件中的公开声明。 |
| `SpeakerMode` | `enum class` | 头文件中的公开声明。 |
| `AudioChannel` | `enum class` | 头文件中的公开声明。 |
| `PlayState` | `enum class` | 头文件中的公开声明。 |
| `StopMode` | `enum class` | 头文件中的公开声明。 |
| `PanMode` | `enum class` | 头文件中的公开声明。 |
| `VolumeSource` | `enum class` | 头文件中的公开声明。 |
| `Audio3DParams` | `struct` | 头文件中的公开声明。 |
| `AudioBufferDesc` | `struct` | 头文件中的公开声明。 |
| `SpatializerParams` | `struct` | 头文件中的公开声明。 |
## 枚举值
| 枚举值 | 数值 | 描述 |
|--------|------|------|
| `AudioClip` | - | 枚举项。 |
| `AudioMixer` | - | 枚举项。 |
| `AudioBank` | - | 枚举项。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

28
docs/api/XCEngine/Audio/Equalizer/Constructor.md Normal file
View File

@@ -0,0 +1,28 @@
# Equalizer::Equalizer()
构造对象。
```cpp
Equalizer();
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

29
docs/api/XCEngine/Audio/Equalizer/Destructor.md Normal file
View File

@@ -0,0 +1,29 @@
# Equalizer::~Equalizer()
销毁对象并释放相关资源。
```cpp
~Equalizer() override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

44
docs/api/XCEngine/Audio/Equalizer/Equalizer.md Normal file
View File

@@ -0,0 +1,44 @@
# Equalizer
**命名空间**: `XCEngine::Audio`
**类型**: `class`
**头文件**: `XCEngine/Audio/Equalizer.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `Equalizer` public API。
## 概述
`Equalizer.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `Equalizer` | `class` | 继承自 `IAudioEffect` 的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [Equalizer()](Constructor.md) | 构造对象。 |
| [~Equalizer()](Destructor.md) | 销毁对象并释放相关资源。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [SetBandCount](SetBandCount.md) | 设置相关状态或配置。 |
| [GetBandCount](GetBandCount.md) | 获取相关状态或对象。 |
| [SetBandFrequency](SetBandFrequency.md) | 设置相关状态或配置。 |
| [GetBandFrequency](GetBandFrequency.md) | 获取相关状态或对象。 |
| [SetBandGain](SetBandGain.md) | 设置相关状态或配置。 |
| [GetBandGain](GetBandGain.md) | 获取相关状态或对象。 |
| [SetBandQ](SetBandQ.md) | 设置相关状态或配置。 |
| [GetBandQ](GetBandQ.md) | 获取相关状态或对象。 |
| [SetEnabled](SetEnabled.md) | 设置相关状态或配置。 |
| [IsEnabled](IsEnabled.md) | 查询当前状态。 |
| [SetWetMix](SetWetMix.md) | 设置相关状态或配置。 |
| [GetWetMix](GetWetMix.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

30
docs/api/XCEngine/Audio/Equalizer/GetBandCount.md Normal file
View File

@@ -0,0 +1,30 @@
# Equalizer::GetBandCount
获取相关状态或对象。
```cpp
uint32 GetBandCount() const;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `uint32` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::GetBandCount(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/GetBandFrequency.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::GetBandFrequency
获取相关状态或对象。
```cpp
float GetBandFrequency(uint32 band) const;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::GetBandFrequency(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/GetBandGain.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::GetBandGain
获取相关状态或对象。
```cpp
float GetBandGain(uint32 band) const;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::GetBandGain(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/GetBandQ.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::GetBandQ
获取相关状态或对象。
```cpp
float GetBandQ(uint32 band) const;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::GetBandQ(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/Equalizer/GetWetMix.md Normal file
View File

@@ -0,0 +1,30 @@
# Equalizer::GetWetMix
获取相关状态或对象。
```cpp
float GetWetMix() const override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::GetWetMix(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/Equalizer/IsEnabled.md Normal file
View File

@@ -0,0 +1,30 @@
# Equalizer::IsEnabled
查询当前状态。
```cpp
bool IsEnabled() const override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::IsEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

33
docs/api/XCEngine/Audio/Equalizer/ProcessAudio.md Normal file
View File

@@ -0,0 +1,33 @@
# Equalizer::ProcessAudio
公开方法，详见头文件声明。
```cpp
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `sampleCount` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/SetBandCount.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::SetBandCount
设置相关状态或配置。
```cpp
void SetBandCount(uint32 count);
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `count` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetBandCount(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

32
docs/api/XCEngine/Audio/Equalizer/SetBandFrequency.md Normal file
View File

@@ -0,0 +1,32 @@
# Equalizer::SetBandFrequency
设置相关状态或配置。
```cpp
void SetBandFrequency(uint32 band, float frequency);
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
- `frequency` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetBandFrequency(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

32
docs/api/XCEngine/Audio/Equalizer/SetBandGain.md Normal file
View File

@@ -0,0 +1,32 @@
# Equalizer::SetBandGain
设置相关状态或配置。
```cpp
void SetBandGain(uint32 band, float gainDb);
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
- `gainDb` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetBandGain(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

32
docs/api/XCEngine/Audio/Equalizer/SetBandQ.md Normal file
View File

@@ -0,0 +1,32 @@
# Equalizer::SetBandQ
设置相关状态或配置。
```cpp
void SetBandQ(uint32 band, float q);
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `band` - 参数语义详见头文件声明。
- `q` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetBandQ(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/SetEnabled.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::SetEnabled
设置相关状态或配置。
```cpp
void SetEnabled(bool enabled) override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `enabled` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/Equalizer/SetWetMix.md Normal file
View File

@@ -0,0 +1,31 @@
# Equalizer::SetWetMix
设置相关状态或配置。
```cpp
void SetWetMix(float wetMix) override;
```
该方法声明于 `XCEngine/Audio/Equalizer.h`，当前页面用于固定 `Equalizer` 类目录下的方法级 canonical 路径。
**参数：**
- `wetMix` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/Equalizer.h>
void Example() {
XCEngine::Audio::Equalizer object;
// 根据上下文补齐参数后调用 Equalizer::SetWetMix(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](Equalizer.md)
- [返回模块目录](../Audio.md)

41
docs/api/XCEngine/Audio/FFTFilter/Constructor.md Normal file
View File

@@ -0,0 +1,41 @@
# FFTFilter::FFTFilter()
构造对象。
该方法在 `XCEngine/Audio/FFTFilter.h` 中提供了 2 个重载，当前页面统一汇总这些公开声明。
## 重载 1: 声明
```cpp
FFTFilter();
```
**参数：** 无。
**返回：** `void` - 无返回值。
## 重载 2: 声明
```cpp
explicit FFTFilter(uint32 fftSize);
```
**参数：**
- `fftSize` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

29
docs/api/XCEngine/Audio/FFTFilter/Destructor.md Normal file
View File

@@ -0,0 +1,29 @@
# FFTFilter::~FFTFilter()
销毁对象并释放相关资源。
```cpp
~FFTFilter() override;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

38
docs/api/XCEngine/Audio/FFTFilter/FFTFilter.md Normal file
View File

@@ -0,0 +1,38 @@
# FFTFilter
**命名空间**: `XCEngine::Audio`
**类型**: `class`
**头文件**: `XCEngine/Audio/FFTFilter.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `FFTFilter` public API。
## 概述
`FFTFilter.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `FFTFilter` | `class` | 继承自 `IAudioEffect` 的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [FFTFilter()](Constructor.md) | 构造对象。 |
| [~FFTFilter()](Destructor.md) | 销毁对象并释放相关资源。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [SetFFTSize](SetFFTSize.md) | 设置相关状态或配置。 |
| [GetFFTSize](GetFFTSize.md) | 获取相关状态或对象。 |
| [SetSmoothingFactor](SetSmoothingFactor.md) | 设置相关状态或配置。 |
| [GetSmoothingFactor](GetSmoothingFactor.md) | 获取相关状态或对象。 |
| [GetSpectrumData](GetSpectrumData.md) | 获取相关状态或对象。 |
| [GetSpectrumSize](GetSpectrumSize.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

30
docs/api/XCEngine/Audio/FFTFilter/GetFFTSize.md Normal file
View File

@@ -0,0 +1,30 @@
# FFTFilter::GetFFTSize
获取相关状态或对象。
```cpp
uint32 GetFFTSize() const;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `uint32` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::GetFFTSize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/FFTFilter/GetSmoothingFactor.md Normal file
View File

@@ -0,0 +1,30 @@
# FFTFilter::GetSmoothingFactor
获取相关状态或对象。
```cpp
float GetSmoothingFactor() const;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::GetSmoothingFactor(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumData.md Normal file
View File

@@ -0,0 +1,30 @@
# FFTFilter::GetSpectrumData
获取相关状态或对象。
```cpp
const float* GetSpectrumData() const;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `const float*` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumData(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/FFTFilter/GetSpectrumSize.md Normal file
View File

@@ -0,0 +1,30 @@
# FFTFilter::GetSpectrumSize
获取相关状态或对象。
```cpp
size_t GetSpectrumSize() const;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `size_t` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::GetSpectrumSize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

33
docs/api/XCEngine/Audio/FFTFilter/ProcessAudio.md Normal file
View File

@@ -0,0 +1,33 @@
# FFTFilter::ProcessAudio
公开方法，详见头文件声明。
```cpp
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels) override;
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `sampleCount` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/FFTFilter/SetFFTSize.md Normal file
View File

@@ -0,0 +1,31 @@
# FFTFilter::SetFFTSize
设置相关状态或配置。
```cpp
void SetFFTSize(uint32 size);
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：**
- `size` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::SetFFTSize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/FFTFilter/SetSmoothingFactor.md Normal file
View File

@@ -0,0 +1,31 @@
# FFTFilter::SetSmoothingFactor
设置相关状态或配置。
```cpp
void SetSmoothingFactor(float factor);
```
该方法声明于 `XCEngine/Audio/FFTFilter.h`，当前页面用于固定 `FFTFilter` 类目录下的方法级 canonical 路径。
**参数：**
- `factor` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/FFTFilter.h>
void Example() {
XCEngine::Audio::FFTFilter object;
// 根据上下文补齐参数后调用 FFTFilter::SetSmoothingFactor(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](FFTFilter.md)
- [返回模块目录](../Audio.md)

28
docs/api/XCEngine/Audio/HRTF/Constructor.md Normal file
View File

@@ -0,0 +1,28 @@
# HRTF::HRTF()
构造对象。
```cpp
HRTF();
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

29
docs/api/XCEngine/Audio/HRTF/Destructor.md Normal file
View File

@@ -0,0 +1,29 @@
# HRTF::~HRTF()
销毁对象并释放相关资源。
```cpp
~HRTF();
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/HRTF/GetCrossFeed.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::GetCrossFeed
获取相关状态或对象。
```cpp
float GetCrossFeed() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::GetCrossFeed(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/HRTF/GetQualityLevel.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::GetQualityLevel
获取相关状态或对象。
```cpp
uint32 GetQualityLevel() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `uint32` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::GetQualityLevel(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/HRTF/GetSpeedOfSound.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::GetSpeedOfSound
获取相关状态或对象。
```cpp
float GetSpeedOfSound() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::GetSpeedOfSound(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

45
docs/api/XCEngine/Audio/HRTF/HRTF.md Normal file
View File

@@ -0,0 +1,45 @@
# HRTF
**命名空间**: `XCEngine::Audio`
**类型**: `class`
**头文件**: `XCEngine/Audio/HRTF.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `HRTF` public API。
## 概述
`HRTF.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `HRTFParams` | `struct` | 头文件中的公开声明。 |
| `HRTF` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [HRTF()](Constructor.md) | 构造对象。 |
| [~HRTF()](Destructor.md) | 销毁对象并释放相关资源。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [SetEnabled](SetEnabled.md) | 设置相关状态或配置。 |
| [IsEnabled](IsEnabled.md) | 查询当前状态。 |
| [SetHRTFEnabled](SetHRTFEnabled.md) | 设置相关状态或配置。 |
| [IsHRTFEnabled](IsHRTFEnabled.md) | 查询当前状态。 |
| [SetQualityLevel](SetQualityLevel.md) | 设置相关状态或配置。 |
| [GetQualityLevel](GetQualityLevel.md) | 获取相关状态或对象。 |
| [SetCrossFeed](SetCrossFeed.md) | 设置相关状态或配置。 |
| [GetCrossFeed](GetCrossFeed.md) | 获取相关状态或对象。 |
| [SetDopplerShiftEnabled](SetDopplerShiftEnabled.md) | 设置相关状态或配置。 |
| [IsDopplerShiftEnabled](IsDopplerShiftEnabled.md) | 查询当前状态。 |
| [SetSpeedOfSound](SetSpeedOfSound.md) | 设置相关状态或配置。 |
| [GetSpeedOfSound](GetSpeedOfSound.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

30
docs/api/XCEngine/Audio/HRTF/IsDopplerShiftEnabled.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::IsDopplerShiftEnabled
查询当前状态。
```cpp
bool IsDopplerShiftEnabled() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::IsDopplerShiftEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/HRTF/IsEnabled.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::IsEnabled
查询当前状态。
```cpp
bool IsEnabled() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::IsEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/HRTF/IsHRTFEnabled.md Normal file
View File

@@ -0,0 +1,30 @@
# HRTF::IsHRTFEnabled
查询当前状态。
```cpp
bool IsHRTFEnabled() const;
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::IsHRTFEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

36
docs/api/XCEngine/Audio/HRTF/ProcessAudio.md Normal file
View File

@@ -0,0 +1,36 @@
# HRTF::ProcessAudio
公开方法，详见头文件声明。
```cpp
void ProcessAudio(float* buffer, uint32 sampleCount, uint32 channels, const Math::Vector3& sourcePosition, const Math::Vector3& listenerPosition, const Math::Quaternion& listenerRotation);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `sampleCount` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
- `sourcePosition` - 参数语义详见头文件声明。
- `listenerPosition` - 参数语义详见头文件声明。
- `listenerRotation` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetCrossFeed.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetCrossFeed
设置相关状态或配置。
```cpp
void SetCrossFeed(float crossFeed);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `crossFeed` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetCrossFeed(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetDopplerShiftEnabled.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetDopplerShiftEnabled
设置相关状态或配置。
```cpp
void SetDopplerShiftEnabled(bool enabled);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `enabled` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetDopplerShiftEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetEnabled.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetEnabled
设置相关状态或配置。
```cpp
void SetEnabled(bool enabled);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `enabled` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetHRTFEnabled.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetHRTFEnabled
设置相关状态或配置。
```cpp
void SetHRTFEnabled(bool enabled);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `enabled` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetHRTFEnabled(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetQualityLevel.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetQualityLevel
设置相关状态或配置。
```cpp
void SetQualityLevel(uint32 level);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `level` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetQualityLevel(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/HRTF/SetSpeedOfSound.md Normal file
View File

@@ -0,0 +1,31 @@
# HRTF::SetSpeedOfSound
设置相关状态或配置。
```cpp
void SetSpeedOfSound(float speed);
```
该方法声明于 `XCEngine/Audio/HRTF.h`，当前页面用于固定 `HRTF` 类目录下的方法级 canonical 路径。
**参数：**
- `speed` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/HRTF.h>
void Example() {
XCEngine::Audio::HRTF object;
// 根据上下文补齐参数后调用 HRTF::SetSpeedOfSound(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](HRTF.md)
- [返回模块目录](../Audio.md)

29
docs/api/XCEngine/Audio/IAudioBackend/Destructor.md Normal file
View File

@@ -0,0 +1,29 @@
# IAudioBackend::~IAudioBackend()
销毁对象并释放相关资源。
```cpp
virtual ~IAudioBackend() = default;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/IAudioBackend/GetAvailableDevices.md Normal file
View File

@@ -0,0 +1,31 @@
# IAudioBackend::GetAvailableDevices
获取相关状态或对象。
```cpp
virtual void GetAvailableDevices(std::vector<std::string>& devices) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `devices` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::GetAvailableDevices(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/GetConfig.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::GetConfig
获取相关状态或对象。
```cpp
virtual AudioConfig GetConfig() const = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `AudioConfig` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::GetConfig(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/GetDeviceName.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::GetDeviceName
获取相关状态或对象。
```cpp
virtual std::string GetDeviceName() const = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `std::string` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::GetDeviceName(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/GetMasterVolume.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::GetMasterVolume
获取相关状态或对象。
```cpp
virtual float GetMasterVolume() const = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `float` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::GetMasterVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

46
docs/api/XCEngine/Audio/IAudioBackend/IAudioBackend.md Normal file
View File

@@ -0,0 +1,46 @@
# IAudioBackend
**命名空间**: `XCEngine::Audio`
**类型**: `class (abstract)`
**头文件**: `XCEngine/Audio/IAudioBackend.h`
**描述**: 定义 `XCEngine/Audio` 子目录中的 `IAudioBackend` public API。
## 概述
`IAudioBackend.h` 是 `XCEngine/Audio` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `IAudioBackend` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [~IAudioBackend()](Destructor.md) | 销毁对象并释放相关资源。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [GetDeviceName](GetDeviceName.md) | 获取相关状态或对象。 |
| [GetAvailableDevices](GetAvailableDevices.md) | 获取相关状态或对象。 |
| [SetDevice](SetDevice.md) | 设置相关状态或配置。 |
| [GetMasterVolume](GetMasterVolume.md) | 获取相关状态或对象。 |
| [SetMasterVolume](SetMasterVolume.md) | 设置相关状态或配置。 |
| [IsMuted](IsMuted.md) | 查询当前状态。 |
| [SetMuted](SetMuted.md) | 设置相关状态或配置。 |
| [Start](Start.md) | 公开方法，详见头文件声明。 |
| [Stop](Stop.md) | 公开方法，详见头文件声明。 |
| [Suspend](Suspend.md) | 公开方法，详见头文件声明。 |
| [Resume](Resume.md) | 公开方法，详见头文件声明。 |
| [ProcessAudio](ProcessAudio.md) | 公开方法，详见头文件声明。 |
| [IsRunning](IsRunning.md) | 查询当前状态。 |
| [GetConfig](GetConfig.md) | 获取相关状态或对象。 |
## 相关文档
- [当前目录](../Audio.md) - 返回 `Audio` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

31
docs/api/XCEngine/Audio/IAudioBackend/Initialize.md Normal file
View File

@@ -0,0 +1,31 @@
# IAudioBackend::Initialize
初始化内部状态。
```cpp
virtual bool Initialize(const AudioConfig& config) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `config` - 参数语义详见头文件声明。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::Initialize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/IsMuted.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::IsMuted
查询当前状态。
```cpp
virtual bool IsMuted() const = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::IsMuted(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/IsRunning.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::IsRunning
查询当前状态。
```cpp
virtual bool IsRunning() const = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::IsRunning(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

34
docs/api/XCEngine/Audio/IAudioBackend/ProcessAudio.md Normal file
View File

@@ -0,0 +1,34 @@
# IAudioBackend::ProcessAudio
公开方法，详见头文件声明。
```cpp
virtual void ProcessAudio(float* buffer, uint32 bufferSize, uint32 channels, uint32 sampleRate) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `buffer` - 参数语义详见头文件声明。
- `bufferSize` - 参数语义详见头文件声明。
- `channels` - 参数语义详见头文件声明。
- `sampleRate` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::ProcessAudio(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

30
docs/api/XCEngine/Audio/IAudioBackend/Resume.md Normal file
View File

@@ -0,0 +1,30 @@
# IAudioBackend::Resume
公开方法，详见头文件声明。
```cpp
virtual void Resume() = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：** 无。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::Resume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/IAudioBackend/SetDevice.md Normal file
View File

@@ -0,0 +1,31 @@
# IAudioBackend::SetDevice
设置相关状态或配置。
```cpp
virtual bool SetDevice(const std::string& deviceName) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `deviceName` - 参数语义详见头文件声明。
**返回：** `bool` - 返回值语义详见头文件声明。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::SetDevice(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/IAudioBackend/SetMasterVolume.md Normal file
View File

@@ -0,0 +1,31 @@
# IAudioBackend::SetMasterVolume
设置相关状态或配置。
```cpp
virtual void SetMasterVolume(float volume) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `volume` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::SetMasterVolume(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

31
docs/api/XCEngine/Audio/IAudioBackend/SetMuted.md Normal file
View File

@@ -0,0 +1,31 @@
# IAudioBackend::SetMuted
设置相关状态或配置。
```cpp
virtual void SetMuted(bool muted) = 0;
```
该方法声明于 `XCEngine/Audio/IAudioBackend.h`，当前页面用于固定 `IAudioBackend` 类目录下的方法级 canonical 路径。
**参数：**
- `muted` - 参数语义详见头文件声明。
**返回：** `void` - 无返回值。
**示例：**
```cpp
#include <XCEngine/Audio/IAudioBackend.h>
void Example() {
XCEngine::Audio::IAudioBackend object;
// 根据上下文补齐参数后调用 IAudioBackend::SetMuted(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](IAudioBackend.md)
- [返回模块目录](../Audio.md)

Some files were not shown because too many files have changed in this diff Show More