XCEngine/docs/api/main.md

XCEngine API Documentation

命名空间: XCEngine

类型: index

描述: 指向 docs/api/XCEngine 平行目录树与审计状态页的统一 API 文档入口。

概览

docs/api/XCEngine/** 是当前唯一正式的 canonical API 文档树，其层级与 engine/include/XCEngine/** 保持平行。

根索引负责两件事：

• 给出所有主要模块的入口导航。
• 指向最新的文档审计状态，方便确认覆盖率、断链和遗留缺口。

Canonical 入口

• XCEngine/XCEngine.md - 与 engine/include/XCEngine 平行的文档根目录
• _meta/rebuild-status.md - 当前覆盖率、链接检查和审计状态

模块导航

模块	Canonical 文档	对应源码目录
Audio	XCEngine/Audio/Audio.md	XCEngine/Audio/
Components	XCEngine/Components/Components.md	XCEngine/Components/
Core	XCEngine/Core/Core.md	XCEngine/Core/
Debug	XCEngine/Debug/Debug.md	XCEngine/Debug/
Editor	XCEngine/Editor/Editor.md	editor/src/
Input	XCEngine/Input/Input.md	XCEngine/Input/
Memory	XCEngine/Memory/Memory.md	XCEngine/Memory/
Platform	XCEngine/Platform/Platform.md	XCEngine/Platform/
Rendering	XCEngine/Rendering/Rendering.md	XCEngine/Rendering/
Resources	XCEngine/Resources/Resources.md	XCEngine/Resources/
RHI	XCEngine/RHI/RHI.md	XCEngine/RHI/
Scene	XCEngine/Scene/Scene.md	XCEngine/Scene/
Scripting	XCEngine/Scripting/Scripting.md	XCEngine/Scripting/
Threading	XCEngine/Threading/Threading.md	XCEngine/Threading/

关键子模块

子模块	Canonical 文档	对应源码目录
Core/Asset	XCEngine/Core/Asset/Asset.md	XCEngine/Core/Asset/
Core/Containers	XCEngine/Core/Containers/Containers.md	XCEngine/Core/Containers/
Core/IO	XCEngine/Core/IO/IO.md	XCEngine/Core/IO/
Core/Math	XCEngine/Core/Math/Math.md	XCEngine/Core/Math/
Editor/Viewport	XCEngine/Editor/Viewport/Viewport.md	editor/src/Viewport/
Rendering/Passes	XCEngine/Rendering/Passes/Passes.md	XCEngine/Rendering/Passes/
Platform/Windows	XCEngine/Platform/Windows/Windows.md	XCEngine/Platform/Windows/
Resources/Mesh	XCEngine/Resources/Mesh/Mesh.md	XCEngine/Resources/Mesh/
Resources/Texture	XCEngine/Resources/Texture/Texture.md	XCEngine/Resources/Texture/
RHI/D3D12	XCEngine/RHI/D3D12/D3D12.md	XCEngine/RHI/D3D12/
RHI/OpenGL	XCEngine/RHI/OpenGL/OpenGL.md	XCEngine/RHI/OpenGL/

相关文档

• XCEngine 平行目录根
• API 文档重构状态
• XCEngine 架构设计