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

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

View File

@@ -33,5 +33,5 @@ void CheckAudioEnergy(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetFrequencyData](./get-frequency-data.md) - 获取频谱数据
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetFrequencyData](get-frequency-data.md) - 获取频谱数据

View File

@@ -33,5 +33,5 @@ void CheckSpectrumSize(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetFrequencyData](./get-frequency-data.md) - 获取频谱数据
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetFrequencyData](get-frequency-data.md) - 获取频谱数据

View File

@@ -38,6 +38,6 @@ void ProcessFrequencyData(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetFrequencyDataSize](./get-frequency-data-size.md) - 获取频谱数据大小
- [GetEnergy](./get-energy.md) - 获取音频能量
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetFrequencyDataSize](get-frequency-data-size.md) - 获取频谱数据大小
- [GetEnergy](get-energy.md) - 获取音频能量

View File

@@ -33,5 +33,5 @@ void PrintReverbLevel(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [SetReverbLevel](./set-reverb-level.md) - 设置混响等级
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [SetReverbLevel](set-reverb-level.md) - 设置混响等级

View File

@@ -38,5 +38,5 @@ void CheckReverb(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [SetReverb](./set-reverb.md) - 设置混响效果器
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [SetReverb](set-reverb.md) - 设置混响效果器

View File

@@ -33,5 +33,5 @@ void PrintSpeedOfSound(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [SetSpeedOfSound](./set-speed-of-sound.md) - 设置声速
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [SetSpeedOfSound](set-speed-of-sound.md) - 设置声速

View File

@@ -36,5 +36,5 @@ void CheckMuteStatus(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [SetMute](./set-mute.md) - 设置静音状态
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [SetMute](set-mute.md) - 设置静音状态

View File

@@ -39,6 +39,6 @@ void SetupDoppler(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetDopplerLevel](./get-doppler-level.md) - 获取多普勒等级
- [SetSpeedOfSound](./set-speed-of-sound.md) - 设置声速
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetDopplerLevel](get-doppler-level.md) - 获取多普勒等级
- [SetSpeedOfSound](set-speed-of-sound.md) - 设置声速

View File

@@ -33,5 +33,5 @@ void ToggleMute(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [IsMute](./is-mute.md) - 检查静音状态
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [IsMute](is-mute.md) - 检查静音状态

View File

@@ -39,6 +39,6 @@ void SetupReverb(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetReverbLevel](./get-reverb-level.md) - 获取混响等级
- [SetReverb](./set-reverb.md) - 设置混响效果器
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetReverbLevel](get-reverb-level.md) - 获取混响等级
- [SetReverb](set-reverb.md) - 设置混响效果器

View File

@@ -35,6 +35,6 @@ void SetupReverbEffect(AudioListenerComponent* listener, AudioMixer* reverbMixer
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetReverb](./get-reverb.md) - 获取混响效果器
- [SetReverbLevel](./set-reverb-level.md) - 设置混响等级
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetReverb](get-reverb.md) - 获取混响效果器
- [SetReverbLevel](set-reverb-level.md) - 设置混响等级

View File

@@ -36,6 +36,6 @@ void SetupSpeedOfSound(AudioListenerComponent* listener) {
## 相关文档
- [AudioListenerComponent](./audio-listener-component.md) - 音频监听器组件
- [GetSpeedOfSound](./get-speed-of-sound.md) - 获取声速
- [SetDopplerLevel](./set-doppler-level.md) - 设置多普勒等级
- [AudioListenerComponent](audio-listener-component.md) - 音频监听器组件
- [GetSpeedOfSound](get-speed-of-sound.md) - 获取声速
- [SetDopplerLevel](set-doppler-level.md) - 设置多普勒等级

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) - 暂停播放

View File

@@ -0,0 +1,38 @@
# GetClearColor
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的清除颜色。
## 函数签名
```cpp
const Math::Color& GetClearColor() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `const Math::Color&` | 清除颜色引用,默认值为深蓝色 (0.192f, 0.302f, 0.475f, 1.0f) |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintClearColor(CameraComponent* camera) {
const auto& color = camera->GetClearColor();
printf("Clear color: (%.2f, %.2f, %.2f, %.2f)\n",
color.r, color.g, color.b, color.a);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetClearColor](set-clear-color.md) - 设置清除颜色

View File

@@ -0,0 +1,37 @@
# GetDepth
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的深度值。
## 函数签名
```cpp
float GetDepth() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `float` | 摄像机深度值,用于确定渲染顺序 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintCameraDepth(CameraComponent* camera) {
float depth = camera->GetDepth();
printf("Camera depth: %.2f\n", depth);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetDepth](set-depth.md) - 设置深度值

View File

@@ -0,0 +1,37 @@
# GetFarClipPlane
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的远裁剪平面距离。
## 函数签名
```cpp
float GetFarClipPlane() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `float` | 远裁剪平面距离,默认值为 1000.0 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintFarPlane(CameraComponent* camera) {
float far = camera->GetFarClipPlane();
printf("Far clip plane: %.2f\n", far);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetFarClipPlane](set-far-clip-plane.md) - 设置远裁剪平面

View File

@@ -0,0 +1,37 @@
# GetFieldOfView
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的视场角(仅在透视投影模式下有效)。
## 函数签名
```cpp
float GetFieldOfView() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `float` | 视场角,单位度,默认值为 60.0 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintFOV(CameraComponent* camera) {
float fov = camera->GetFieldOfView();
printf("Field of view: %.1f degrees\n", fov);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetFieldOfView](set-field-of-view.md) - 设置视场角

View File

@@ -0,0 +1,39 @@
# GetNearClipPlane
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的近裁剪平面距离。
## 函数签名
```cpp
float GetNearClipPlane() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `float` | 近裁剪平面距离,默认值为 0.1 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintClipPlanes(CameraComponent* camera) {
float near = camera->GetNearClipPlane();
float far = camera->GetFarClipPlane();
printf("Clip planes: %.2f to %.2f\n", near, far);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetNearClipPlane](set-near-clip-plane.md) - 设置近裁剪平面
- [GetFarClipPlane](get-far-clip-plane.md) - 获取远裁剪平面

View File

@@ -0,0 +1,37 @@
# GetOrthographicSize
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的正交投影大小(仅在正交投影模式下有效)。
## 函数签名
```cpp
float GetOrthographicSize() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `float` | 正交投影大小,默认值为 5.0 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void PrintOrthoSize(CameraComponent* camera) {
float size = camera->GetOrthographicSize();
printf("Orthographic size: %.2f\n", size);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetOrthographicSize](set-orthographic-size.md) - 设置正交大小

View File

@@ -0,0 +1,40 @@
# GetProjectionType
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 获取摄像机的投影类型。
## 函数签名
```cpp
CameraProjectionType GetProjectionType() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `CameraProjectionType` | 投影类型,可能是 `Perspective`(透视)或 `Orthographic`(正交) |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void CheckProjection(CameraComponent* camera) {
if (camera->GetProjectionType() == CameraProjectionType::Perspective) {
printf("Using perspective projection\n");
} else {
printf("Using orthographic projection\n");
}
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetProjectionType](set-projection-type.md) - 设置投影类型

View File

@@ -0,0 +1,38 @@
# IsPrimary
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 检查摄像机是否为主摄像机。
## 函数签名
```cpp
bool IsPrimary() const;
```
## 返回值
| 类型 | 描述 |
|------|------|
| `bool` | true 表示为主摄像机false 表示非主摄像机 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void CheckPrimaryCamera(CameraComponent* camera) {
if (camera->IsPrimary()) {
printf("This is the primary camera\n");
}
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [SetPrimary](set-primary.md) - 设置为主摄像机

View File

@@ -0,0 +1,41 @@
# SetClearColor
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的清除颜色。
## 函数签名
```cpp
void SetClearColor(const Math::Color& value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `const Math::Color&` | 清除颜色引用 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
#include <XCEngine/Core/Math/Color.h>
using namespace XCEngine::Components;
void SetupClearColor(CameraComponent* camera) {
// 设置为黑色
camera->SetClearColor(Math::Color::Black());
// 设置为天蓝色
camera->SetClearColor(Math::Color(0.5f, 0.8f, 1.0f, 1.0f));
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetClearColor](get-clear-color.md) - 获取清除颜色

View File

@@ -0,0 +1,37 @@
# SetDepth
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的深度值,用于确定渲染顺序。
## 函数签名
```cpp
void SetDepth(float value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `float` | 深度值,值越大越晚渲染(显示在前面) |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupCameraOrder(CameraComponent* mainCam, CameraComponent* uiCam) {
mainCam->SetDepth(0.0f); // 主摄像机先渲染
uiCam->SetDepth(1.0f); // UI摄像机后渲染
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetDepth](get-depth.md) - 获取深度值

View File

@@ -0,0 +1,36 @@
# SetFarClipPlane
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的远裁剪平面距离。
## 函数签名
```cpp
void SetFarClipPlane(float value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `float` | 远裁剪平面距离,必须大于近裁剪平面 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupFarPlane(CameraComponent* camera) {
camera->SetFarClipPlane(5000.0f); // 5公里
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetFarClipPlane](get-far-clip-plane.md) - 获取远裁剪平面

View File

@@ -0,0 +1,43 @@
# SetFieldOfView
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的视场角(仅在透视投影模式下有效)。
## 函数签名
```cpp
void SetFieldOfView(float value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `float` | 视场角,单位度,通常在 30.0 到 120.0 之间 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupCameraFOV(CameraComponent* camera) {
// 宽广视野FPS游戏
camera->SetFieldOfView(90.0f);
// 窄视野(狙击视角)
camera->SetFieldOfView(30.0f);
// 标准视野
camera->SetFieldOfView(60.0f);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetFieldOfView](get-field-of-view.md) - 获取视场角

View File

@@ -0,0 +1,36 @@
# SetNearClipPlane
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的近裁剪平面距离。
## 函数签名
```cpp
void SetNearClipPlane(float value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `float` | 近裁剪平面距离,必须大于 0 且小于远裁剪平面 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupNearPlane(CameraComponent* camera) {
camera->SetNearClipPlane(0.5f); // 50厘米
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetNearClipPlane](get-near-clip-plane.md) - 获取近裁剪平面

View File

@@ -0,0 +1,37 @@
# SetOrthographicSize
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的正交投影大小(仅在正交投影模式下有效)。
## 函数签名
```cpp
void SetOrthographicSize(float value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `float` | 正交投影大小,表示视口半高度 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupOrthoCamera(CameraComponent* camera) {
camera->SetProjectionType(CameraProjectionType::Orthographic);
camera->SetOrthographicSize(5.0f); // 视口高度为10个单位
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetOrthographicSize](get-orthographic-size.md) - 获取正交大小

View File

@@ -0,0 +1,36 @@
# SetPrimary
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机是否为主摄像机。
## 函数签名
```cpp
void SetPrimary(bool value);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `value` | `bool` | true 设置为主摄像机false 取消主摄像机 |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupMainCamera(CameraComponent* camera) {
camera->SetPrimary(true);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [IsPrimary](is-primary.md) - 检查是否为主摄像机

View File

@@ -0,0 +1,40 @@
# SetProjectionType
**所属类**: `CameraComponent`
**头文件**: `XCEngine/Components/CameraComponent.h`
**描述**: 设置摄像机的投影类型。
## 函数签名
```cpp
void SetProjectionType(CameraProjectionType type);
```
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `type` | `CameraProjectionType` | 投影类型:`Perspective`(透视)或 `Orthographic`(正交) |
## 使用示例
```cpp
#include <XCEngine/Components/CameraComponent.h>
using namespace XCEngine::Components;
void SetupCamera(CameraComponent* camera) {
// 透视投影3D游戏
camera->SetProjectionType(CameraProjectionType::Perspective);
// 正交投影2D游戏或UI
camera->SetProjectionType(CameraProjectionType::Orthographic);
}
```
## 相关文档
- [CameraComponent](camera-component.md) - 摄像机组件
- [GetProjectionType](get-projection-type.md) - 获取投影类型