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

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

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

2
docs/api/resources/asyncloader/asyncloader.md
View File

@@ -4,7 +4,7 @@
**类型**: `class` (singleton)
**头文件**: `XCEngine/Resources/AsyncLoader.h`
**头文件**: `XCEngine/Core/Asset/AsyncLoader.h`
**描述**: 异步资源加载器单例，负责多线程后台资源加载和完成回调调度。

8
docs/api/resources/audioclip/audioclip.md
View File

@@ -4,7 +4,7 @@
**类型**: `class`
**头文件**: `XCEngine/Resources/AudioClip.h`
**头文件**: `XCEngine/Resources/AudioClip/AudioClip.h`
**描述**: 音频片段资源类，管理音频样本数据、格式信息和播放参数。
@@ -15,7 +15,7 @@
## 头文件
```cpp
#include <XCEngine/Resources/AudioClip.h>
#include <XCEngine/Resources/AudioClip/AudioClip.h>
```
## 枚举类型
@@ -119,7 +119,7 @@
## 使用示例
```cpp
#include <XCEngine/Resources/AudioClip.h>
#include <XCEngine/Resources/AudioClip/AudioClip.h>
#include <XCEngine/Resources/ResourceManager.h>
using namespace XCEngine::Resources;
@@ -149,5 +149,5 @@ bool loop = sfx->IsLoop();
## 相关文档
- [IResource](../iresource/iresource.md) - 资源基类
- [ResourceManager](../resourcemanager/resourcemanager.md) - 资源管理器
- [ResourceManager](../resource-manager/resource-manager.md) - 资源管理器
- [Resources 总览](../resources.md) - 返回模块总览

8
docs/api/resources/filearchive/filearchive.md
View File

@@ -4,7 +4,7 @@
**类型**: `class`
**头文件**: `XCEngine/Resources/FileArchive.h`
**头文件**: `XCEngine/Core/IO/FileArchive.h`
**继承自**: `IArchive`
@@ -39,7 +39,7 @@ IArchive
## 使用示例
```cpp
#include <XCEngine/Resources/FileArchive.h>
#include <XCEngine/Core/IO/FileArchive.h>
// 创建并打开归档
FileArchive archive;
@@ -71,5 +71,5 @@ if (archive.Open("resources/textures/")) {
## 相关文档
- [Resources 模块总览](../resources.md) - 返回模块总览
- [IArchive](../resourcefilesystem/resourcefilesystem.md) - 归档接口定义
- [ResourceFileSystem](../resourcefilesystem/resourcefilesystem.md) - 资源文件系统
- [IArchive](../resource-file-system/iarchive.md) - 归档接口定义
- [ResourceFileSystem](../resource-file-system/index.md) - 资源文件系统

2
docs/api/resources/material/material.md
View File

@@ -160,5 +160,5 @@ mat->Release();
- [IResource](../iresource/iresource.md) - 资源基类接口
- [Shader](../shader/shader.md) - 着色器资源
- [Texture](../texture/texture.md) - 纹理资源
- [ResourceHandle](../resourcehandle/resourcehandle.md) - 资源句柄
- [ResourceHandle](../resourcehandle.md) - 资源句柄
- [Resources 模块总览](../resources.md) - 返回模块总览

2
docs/api/resources/mesh-import-settings/mesh-import-settings.md
View File

@@ -97,5 +97,5 @@ ResourceHandle<Mesh> mesh = ResourceManager::Get().Load<Mesh>("models/player.fbx
- [ImportSettings](../importsettings/importsettings.md) - 导入设置基类
- [IResourceLoader](../iloader/iloader.md) - 资源加载器接口
- [ResourceManager](../resourcemanager/resourcemanager.md) - 资源管理器
- [ResourceManager](../resource-manager/resource-manager.md) - 资源管理器
- [Resources 总览](../resources.md) - 资源模块总览

2
docs/api/resources/resource-dependency-graph/index.md
View File

@@ -48,7 +48,7 @@
## 使用示例
```cpp
#include "Resources/ResourceDependencyGraph.h"
#include <XCEngine/Core/Asset/ResourceDependencyGraph.h>
using namespace XCEngine;
using namespace Resources;

10
docs/api/resources/resource-manager/resource-manager.md
View File

@@ -159,8 +159,8 @@ resMgr.Shutdown();
## 相关文档
- [IResourceLoader](iloader/iloader.md) - 资源加载器接口
- [AsyncLoader](asyncloader/asyncloader.md) - 异步加载器
- [ResourceCache](resourcecache.md) - 资源缓存
- [ResourceHandle](resourcehandle.md) - 资源句柄
- [Resources 总览](resources.md) - 返回模块总览
- [IResourceLoader](../iloader/iloader.md) - 资源加载器接口
- [AsyncLoader](../asyncloader/asyncloader.md) - 异步加载器
- [ResourceCache](../resourcecache.md) - 资源缓存
- [ResourceHandle](../resourcehandle.md) - 资源句柄
- [Resources 总览](../resources.md) - 返回模块总览

2
docs/api/resources/resource-package/index.md
View File

@@ -50,7 +50,7 @@ ResourcePackage 提供了一套完整的资源包读取接口，包括打开/关
## 使用示例
```cpp
#include "Resources/ResourcePackage.h"
#include <XCEngine/Core/IO/ResourcePackage.h>
using namespace XCEngine;
using namespace XCEngine::Containers;

6
docs/api/resources/texture-loader/index.md
View File

@@ -15,7 +15,7 @@
## 头文件
```cpp
#include <XCEngine/Resources/TextureLoader.h>
#include <XCEngine/Resources/Texture/TextureLoader.h>
```
## 支持的格式
@@ -114,8 +114,8 @@ ImportSettings* GetDefaultSettings() const override
## 使用示例
```cpp
#include <XCEngine/Resources/TextureLoader.h>
#include <XCEngine/Resources/ResourceManager.h>
#include <XCEngine/Resources/Texture/TextureLoader.h>
#include <XCEngine/Core/Asset/ResourceManager.h>
using namespace XCEngine::Resources;