ssdfasd
b414bc5326
Fixed broken references: - texture-import-settings: Fix 16 files referencing wrong overview filename - math/rectint: Fix 9 method links (rectint-* → get*, contains, intersects) - rhi/opengl/device: Fix 8 cross-references (opengl-* → */**) - resources/mesh: Fix meshsection and vertexattribute links - rhi/d3d12/sampler: Fix RHISampler reference path - math/vector3: Fix projectonplane → project-on-plane - rhi/opengl/command-list: Remove broken ClearFlag enum ref - rhi/opengl/device: Create 2 new method docs (MakeContextCurrent, GetNativeContext) - rhi/device: Fix device-info types reference All 0 broken references remaining.
2.7 KiB
2.7 KiB
XCEngine API 文档总索引
描述: XCEngine 图形引擎的完整 API 文档索引。
模块导航
| 模块 | 文档目录 | 描述 |
|---|---|---|
| RHI | rhi/ | 渲染硬件接口抽象层 |
| D3D12 | rhi/d3d12/ | DirectX 12 后端实现 |
| OpenGL | rhi/opengl/ | OpenGL 后端实现 |
| Containers | containers/ | 容器数据结构 |
| Memory | memory/ | 内存管理 |
| Threading | threading/ | 多线程和任务系统 |
| Core | core/ | 核心基础类型 |
| Debug | debug/ | 调试和日志 |
| Math | math/ | 数学库 |
| Resources | resources/ | 资源管理系统 |
| Audio | audio/ | 音频系统 |
| Components | components/ | ECS 组件系统 |
| Scene | scene/ | 场景管理系统 |
快速开始
创建渲染设备
#include <XCEngine/RHI/RHIFactory.h>
#include <XCEngine/RHI/RHIDevice.h>
// 创建 D3D12 设备
RHI::RHIDevice* device = RHI::RHIFactory::CreateRHIDevice(RHI::RHIType::D3D12);
// 初始化
RHI::RHIDeviceDesc desc;
desc.windowHandle = hwnd;
device->Initialize(desc);
使用资源管理器
#include <XCEngine/Resources/Resources.h>
// 加载纹理
auto texture = XCEngine::Resources::ResourceManager::Get().Load<XCEngine::Resources::Texture>("textures/player.png");
// 加载网格
auto mesh = XCEngine::Resources::ResourceManager::Get().Load<XCEngine::Resources::Mesh>("models/player.fbx");
日志记录
#include <XCEngine/Debug/Logger.h>
// 记录日志
XE_LOG(Debug::LogCategory::Rendering, Debug::LogLevel::Info, "Render started");
数学运算
#include <XCEngine/Core/Math/Matrix4.h>
// 创建变换矩阵
Math::Matrix4x4 transform = Math::Matrix4x4::TRS(position, rotation, scale);
文档统计
⚠️ 注意：以下统计数据为近似值，部分 RHI 伪造文档待删除后需重新统计。
| 模块 | 文档数量 |
|---|---|
| RHI 抽象层 | ~15 (含待删除伪造文档) |
| D3D12 后端 | ~20 |
| OpenGL 后端 | ~25 (含待删除伪造文档) |
| Math | ~15 |
| Resources | ~20 |
| Threading | ~15 |
| Memory | ~12 |
| Debug | ~10 |
| Core | ~5 |
| Containers | ~4 |
| Audio | ~20 |
| Components | ~50 |
| Scene | ~10 |
| 总计 | ~220 (待精确统计) |