docs: 更新 resources, rhi, scene 模块及新增 camera-component 方法文档

- resources: 更新 asyncloader, audioclip, mesh-import-settings, texture-loader 文档
- rhi: 更新 opengl render-target-view 文档
- components: 新增 camera-component 全部方法文档 (15个文件)
This commit is contained in:
2026-03-26 02:00:45 +08:00
parent f778c76325
commit a1804f4cb0
72 changed files with 738 additions and 131 deletions

View File

@@ -78,7 +78,7 @@ AudioSourceComponent 是 XCEngine ECS 系统中的音频源组件,用于在场
| 方法 | 描述 |
|------|------|
| [`GetEnergy`](get-energy.md) | 获取当前能量值 |
| [`GetEnergy`](../audio-listener-component/get-energy.md) | 获取当前能量值 |
| [`StartEnergyDetect`](start-energy-detect.md) | 开始能量检测 |
| [`StopEnergyDetect`](stop-energy-detect.md) | 停止能量检测 |
| [`IsEnergyDetecting`](is-energy-detecting.md) | 检查是否正在能量检测 |

View File

@@ -34,5 +34,5 @@ void Print3DParams(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [Set3DParams](./set-3d-params.md) - 设置3D参数
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [Set3DParams](../../audio/audio-mixer/set-3d-params.md) - 设置3D参数

View File

@@ -37,5 +37,5 @@ void CheckCurrentClip(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetClip](./set-clip.md) - 设置音频片段
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetClip](set-clip.md) - 设置音频片段

View File

@@ -33,5 +33,5 @@ void PrintDopplerLevel(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetDopplerLevel](./set-doppler-level.md) - 设置多普勒等级
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetDopplerLevel](set-doppler-level.md) - 设置多普勒等级

View File

@@ -33,6 +33,6 @@ void PrintDuration(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetTime](./get-time.md) - 获取当前播放位置
- [SetClip](./set-clip.md) - 设置音频片段
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetTime](get-time.md) - 获取当前播放位置
- [SetClip](set-clip.md) - 设置音频片段

View File

@@ -37,5 +37,5 @@ void CheckOutputMixer(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetOutputMixer](./set-output-mixer.md) - 设置输出混音器
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetOutputMixer](../../audio/audio-mixer/set-output-mixer.md) - 设置输出混音器

View File

@@ -33,5 +33,5 @@ void PrintPan(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetPan](./set-pan.md) - 设置平移值
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetPan](set-pan.md) - 设置平移值

View File

@@ -33,5 +33,5 @@ void PrintPitch(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetPitch](./set-pitch.md) - 设置音高
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetPitch](set-pitch.md) - 设置音高

View File

@@ -33,5 +33,5 @@ void PrintReverbZoneMix(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetReverbZoneMix](./set-reverb-zone-mix.md) - 设置混响混合比例
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetReverbZoneMix](set-reverb-zone-mix.md) - 设置混响混合比例

View File

@@ -33,5 +33,5 @@ void PrintSpread(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetSpread](./set-spread.md) - 设置扩散角度
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetSpread](set-spread.md) - 设置扩散角度

View File

@@ -34,6 +34,6 @@ void PrintCurrentTime(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetTime](./set-time.md) - 设置播放位置
- [GetDuration](./get-duration.md) - 获取总时长
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetTime](set-time.md) - 设置播放位置
- [GetDuration](get-duration.md) - 获取总时长

View File

@@ -33,5 +33,5 @@ void PrintVolume(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetVolume](./set-volume.md) - 设置音量
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetVolume](../../audio/audio-mixer/set-volume.md) - 设置音量

View File

@@ -35,7 +35,7 @@ void CheckEnergyDetection(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [StartEnergyDetect](./start-energy-detect.md) - 开始能量检测
- [StopEnergyDetect](./stop-energy-detect.md) - 停止能量检测
- [GetEnergy](./get-energy.md) - 获取当前能量值
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [StartEnergyDetect](start-energy-detect.md) - 开始能量检测
- [StopEnergyDetect](stop-energy-detect.md) - 停止能量检测
- [GetEnergy](../audio-listener-component/get-energy.md) - 获取当前能量值

View File

@@ -34,5 +34,5 @@ void CheckLoopingStatus(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetLooping](./set-looping.md) - 设置循环播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetLooping](set-looping.md) - 设置循环播放

View File

@@ -34,5 +34,5 @@ void CheckPausedStatus(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [IsPlaying](./is-playing.md) - 检查是否正在播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [IsPlaying](is-playing.md) - 检查是否正在播放

View File

@@ -36,5 +36,5 @@ void CheckPlayingStatus(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [IsPaused](./is-paused.md) - 检查是否暂停
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [IsPaused](is-paused.md) - 检查是否暂停

View File

@@ -34,5 +34,5 @@ void CheckSpatializeStatus(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [SetSpatialize](./set-spatialize.md) - 设置空间化
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [SetSpatialize](set-spatialize.md) - 设置空间化

View File

@@ -26,6 +26,6 @@ void PauseAudio(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [Play](./play.md) - 开始播放
- [Stop](./stop.md) - 停止播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [Play](play.md) - 开始播放
- [Stop](stop.md) - 停止播放

View File

@@ -26,6 +26,6 @@ void StartPlayback(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [Pause](./pause.md) - 暂停播放
- [Stop](./stop.md) - 停止播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [Pause](pause.md) - 暂停播放
- [Stop](stop.md) - 停止播放

View File

@@ -35,5 +35,5 @@ void LoadAndPlaySound(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetClip](./get-clip.md) - 获取当前音频片段
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetClip](get-clip.md) - 获取当前音频片段

View File

@@ -32,5 +32,5 @@ void SetupDoppler(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetDopplerLevel](./get-doppler-level.md) - 获取多普勒等级
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetDopplerLevel](get-doppler-level.md) - 获取多普勒等级

View File

@@ -32,5 +32,5 @@ void SetupLooping(AudioSourceComponent* source, bool shouldLoop) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [IsLooping](./is-looping.md) - 检查是否循环播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [IsLooping](is-looping.md) - 检查是否循环播放

View File

@@ -39,5 +39,5 @@ void SetupPan(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetPan](./get-pan.md) - 获取平移值
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetPan](get-pan.md) - 获取平移值

View File

@@ -39,5 +39,5 @@ void SetupPitch(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetPitch](./get-pitch.md) - 获取音高
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetPitch](get-pitch.md) - 获取音高

View File

@@ -39,5 +39,5 @@ void SetupReverbZoneMix(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetReverbZoneMix](./get-reverb-zone-mix.md) - 获取混响混合比例
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetReverbZoneMix](get-reverb-zone-mix.md) - 获取混响混合比例

View File

@@ -36,5 +36,5 @@ void SetupSpatialize(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [IsSpatialize](./is-spatialize.md) - 检查是否启用空间化
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [IsSpatialize](is-spatialize.md) - 检查是否启用空间化

View File

@@ -39,5 +39,5 @@ void SetupSpread(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetSpread](./get-spread.md) - 获取扩散角度
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetSpread](get-spread.md) - 获取扩散角度

View File

@@ -36,6 +36,6 @@ void RewindToStart(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [GetTime](./get-time.md) - 获取当前播放位置
- [GetDuration](./get-duration.md) - 获取总时长
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [GetTime](get-time.md) - 获取当前播放位置
- [GetDuration](get-duration.md) - 获取总时长

View File

@@ -26,7 +26,7 @@ void BeginEnergyDetection(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [StopEnergyDetect](./stop-energy-detect.md) - 停止能量检测
- [IsEnergyDetecting](./is-energy-detecting.md) - 检查是否正在检测
- [GetEnergy](./get-energy.md) - 获取当前能量值
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [StopEnergyDetect](stop-energy-detect.md) - 停止能量检测
- [IsEnergyDetecting](is-energy-detecting.md) - 检查是否正在检测
- [GetEnergy](../audio-listener-component/get-energy.md) - 获取当前能量值

View File

@@ -26,6 +26,6 @@ void EndEnergyDetection(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [StartEnergyDetect](./start-energy-detect.md) - 开始能量检测
- [IsEnergyDetecting](./is-energy-detecting.md) - 检查是否正在检测
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [StartEnergyDetect](start-energy-detect.md) - 开始能量检测
- [IsEnergyDetecting](is-energy-detecting.md) - 检查是否正在检测

View File

@@ -37,6 +37,6 @@ void FadeOutAndStop(AudioSourceComponent* source) {
## 相关文档
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
- [Play](./play.md) - 开始播放
- [Pause](./pause.md) - 暂停播放
- [AudioSourceComponent](audio-source-component.md) - 音频源组件
- [Play](play.md) - 开始播放
- [Pause](pause.md) - 暂停播放