docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
34
docs/api/resources/iresource/initialize.md
Normal file
34
docs/api/resources/iresource/initialize.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# IResource::Initialize
|
||||
|
||||
```cpp
|
||||
void Initialize(const ConstructParams& params)
|
||||
```
|
||||
|
||||
使用构造参数初始化资源。将参数中的名称、路径、GUID 和内存大小写入对应成员变量,并将资源标记为有效状态。
|
||||
|
||||
**参数:**
|
||||
- `params` - 包含资源名称、路径、GUID 和内存大小的构造参数结构体
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
class MyResource : public IResource {
|
||||
public:
|
||||
MyResource() {
|
||||
ConstructParams params;
|
||||
params.name = "player_texture";
|
||||
params.path = "textures/player.png";
|
||||
params.guid = ResourceGUID::Generate(params.path);
|
||||
params.memorySize = 1024 * 1024; // 1MB
|
||||
Initialize(params);
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [IResource 总览](iresource.md) - 返回类总览
|
||||
Reference in New Issue
Block a user