From a2765a282e1a6cec7a5d1f960e9a5ae097e1bc98 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Thu, 26 Mar 2026 02:03:53 +0800 Subject: [PATCH] fix(docs): fix MeshLoader constructor and Fence doc references --- .../audio-source-component/set-3d-params.md | 40 +++++++++++++++++++ .../audio-source-component/set-volume.md | 36 +++++++++++++++++ .../mesh-loader/methods/constructor.md | 2 +- docs/api/rhi/fence/fence.md | 5 --- 4 files changed, 77 insertions(+), 6 deletions(-) create mode 100644 docs/api/components/audio-source-component/set-3d-params.md create mode 100644 docs/api/components/audio-source-component/set-volume.md diff --git a/docs/api/components/audio-source-component/set-3d-params.md b/docs/api/components/audio-source-component/set-3d-params.md new file mode 100644 index 00000000..01b3fa94 --- /dev/null +++ b/docs/api/components/audio-source-component/set-3d-params.md @@ -0,0 +1,40 @@ +# Set3DParams + +**所属类**: `AudioSourceComponent` + +**头文件**: `XCEngine/Components/AudioSourceComponent.h` + +**描述**: 设置音频源的3D音频参数。 + +## 函数签名 + +```cpp +void Set3DParams(const Audio::Audio3DParams& params); +``` + +## 参数 + +| 参数 | 类型 | 描述 | +|------|------|------| +| `params` | `const Audio::Audio3DParams&` | 3D音频参数引用,包含多普勒等级、扩散角度、混响混合等 | + +## 使用示例 + +```cpp +#include + +using namespace XCEngine::Components; + +void Setup3DParams(AudioSourceComponent* source) { + Audio::Audio3DParams params; + params.dopplerLevel = 1.0f; // 正常多普勒效应 + params.spread = 0.0f; // 点声源 + params.reverbZoneMix = 1.0f; // 最大混响混合 + source->Set3DParams(params); +} +``` + +## 相关文档 + +- [AudioSourceComponent](./audio-source-component.md) - 音频源组件 +- [Get3DParams](./get-3d-params.md) - 获取3D参数 diff --git a/docs/api/components/audio-source-component/set-volume.md b/docs/api/components/audio-source-component/set-volume.md new file mode 100644 index 00000000..965c6492 --- /dev/null +++ b/docs/api/components/audio-source-component/set-volume.md @@ -0,0 +1,36 @@ +# SetVolume + +**所属类**: `AudioSourceComponent` + +**头文件**: `XCEngine/Components/AudioSourceComponent.h` + +**描述**: 设置音频源的音量。 + +## 函数签名 + +```cpp +void SetVolume(float volume); +``` + +## 参数 + +| 参数 | 类型 | 描述 | +|------|------|------| +| `volume` | `float` | 音量,范围 0.0 到 1.0 | + +## 使用示例 + +```cpp +#include + +using namespace XCEngine::Components; + +void SetAudioVolume(AudioSourceComponent* source) { + source->SetVolume(0.5f); // 50% 音量 +} +``` + +## 相关文档 + +- [AudioSourceComponent](./audio-source-component.md) - 音频源组件 +- [GetVolume](./get-volume.md) - 获取音量 diff --git a/docs/api/resources/mesh-loader/methods/constructor.md b/docs/api/resources/mesh-loader/methods/constructor.md index 1e0d67a9..09ed98b9 100644 --- a/docs/api/resources/mesh-loader/methods/constructor.md +++ b/docs/api/resources/mesh-loader/methods/constructor.md @@ -21,7 +21,7 @@ MeshLoader(); ## 示例 ```cpp -#include "Resources/MeshLoader.h" +#include using namespace XCEngine::Resources; diff --git a/docs/api/rhi/fence/fence.md b/docs/api/rhi/fence/fence.md index 5600b35f..1266a2a4 100644 --- a/docs/api/rhi/fence/fence.md +++ b/docs/api/rhi/fence/fence.md @@ -43,11 +43,6 @@ fence->Signal(); // 在 CPU 端等待 GPU 完成 fence->Wait(fence->GetCompletedValue()); -// 检查是否已完成 -if (fence->IsSignaled()) { - // GPU 工作已完成 -} - // 获取原生句柄用于平台特定操作 void* nativeHandle = fence->GetNativeHandle();