xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
536 Commits 1 Branch 0 Tags
476a56724ffa70823006c8ed4148cf2dd2df59c3
Commit Graph

29 Commits

Author SHA1 Message Date
ssdfasd
b414bc5326 refactor(docs): Fix broken links across multiple modules 
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.
 2026-03-26 02:41:00 +08:00
ssdfasd
10ee1fa3fa docs: 更新 audioclip 和 audio-source-component 文档 
- audioclip: 新增 set 方法文档
- audio-source-component: 新增 set-output-mixer 文档
 2026-03-26 02:04:27 +08:00
ssdfasd
a2765a282e fix(docs): fix MeshLoader constructor and Fence doc references 2026-03-26 02:03:53 +08:00
ssdfasd
4ca8773eef fix(docs): fix AudioClip links, ResourcePackage path, Fence and Scene broken references 2026-03-26 02:03:19 +08:00
ssdfasd
582ab2c730 docs: 更新多个模块文档 
- resources: 更新 audioclip 和 resourcepath 文档
- rhi: 更新 d3d12 和 opengl 文档
 2026-03-26 02:02:42 +08:00
ssdfasd
02e48b4766 fix(docs): correct D3D12 Fence cross-references to use local fence links instead of threading 2026-03-26 02:02:33 +08:00
ssdfasd
c2354530b9 docs: 新增 light-component 全部方法文档及更新其他模块 
- components: 新增 light-component 全部12个方法文档
- resources: 更新 audio-loader, resource-file-system 文档
- rhi: 更新 opengl/fence 文档
 2026-03-26 02:02:21 +08:00
ssdfasd
a1804f4cb0 docs: 更新 resources, rhi, scene 模块及新增 camera-component 方法文档 
- resources: 更新 asyncloader, audioclip, mesh-import-settings, texture-loader 文档
- rhi: 更新 opengl render-target-view 文档
- components: 新增 camera-component 全部方法文档 (15个文件)
 2026-03-26 02:00:45 +08:00
ssdfasd
f778c76325 fix(docs): update Shader header path and RHI source link for engine restructure 2026-03-26 02:00:14 +08:00
ssdfasd
8df04c120f docs: 更新 API 文档 - 多模块修复和完善 
- audio: 更新 audio-system 方法文档
- components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法
- core: 更新 filewriter, types 文档
- math: 更新 box 方法文档
- memory: 更新 proxy-allocator 文档
- resources: 更新 loader 和 texture 文档
- rhi: 更新 opengl 设备、shader、swap-chain 文档
- threading: 更新 mutex 和 task-system 文档
 2026-03-26 01:58:45 +08:00
ssdfasd
445876752c docs: 修复 containers 和 rhi 模块的头文件路径 
- containers: 修正 Containers.h, Array.h, String.h, HashMap.h 的路径为 Core/Containers/
- rhi: 修正 D3D12 和 OpenGL 后端文档路径
 2026-03-26 01:58:16 +08:00
ssdfasd
56ee358b5c docs: 修复 RHI 模块中损坏的文档链接 
修正 d3d12 和 opengl 后端文档路径引用
 2026-03-26 01:57:12 +08:00
ssdfasd
1cf744b755 refactor(docs): RHI模块文档重构 - 修复18处链接错误并新增RHIFramebuffer/RHIRenderPass文档 
- 修复opengl/下13个文件对overview.md的错误引用，改为opengl.md
- 修复opengl/shader/下2处get-native-handle.md的错误路径引用
- 修复rhi.md中rhifactory路径错误
- 修复opengl.md中对d3d12.md的错误引用
- 修复opengl/README.md中的overview.md引用
- 新增RHIFramebuffer完整文档(7个文件)
- 新增RHIRenderPass完整文档(7个文件)
- 更新rhi.md总览页，添加RHIFramebuffer和RHIRenderPass分类
 2026-03-26 01:29:00 +08:00
ssdfasd
f427699ac6 refactor: improve test infrastructure and fix OpenGL GLAD initialization 
- Rename D3D12Enum.h to D3D12Enums.h for naming consistency
- Fix OpenGL unit test GLAD initialization by using gladLoadGL()
  instead of gladLoadGLLoader(wglGetProcAddress) for fallback support
- Migrate remaining tests to use gtest_discover_tests for granular
  test discovery (math, core, containers, memory, threading, debug,
  components, scene, resources, input, opengl)
- Remove obsolete TEST_RESOURCES_DIR and copy_directory commands
  from OpenGL unit test CMakeLists (minimal/Res doesn't exist)
- Update TEST_SPEC.md with performance metrics and per-module
  build/test commands for faster development workflow
- Update CMake path references to use lowercase paths
 2026-03-23 00:43:02 +08:00
ssdfasd
d83ed56177 fix(rhi): Fix RHI abstraction layer API docs per api-skill.md template 
- Rename texture/dtor.md to destructor.md per template spec
- Remove duplicate non-hyphenated fence docs (getnativehandle.md, issignaled.md, getcompletedvalue.md)
- Fix template field issues:
  - swap-chain, command-queue: 类型 now uses 'class (abstract)'
  - sampler: 头文件 now uses full path 'XCEngine/RHI/RHISampler.h'
  - types: 类型 fixed from 'structs' to 'struct'
  - enums: 类型 fixed from 'enums' to 'enum class'
- Fix include paths in command-queue and pipeline-layout code examples
- Create missing constructor/destructor docs for 11 classes:
  buffer, texture, shader, device, command-list, command-queue,
  fence, sampler, swap-chain, pipeline-state, pipeline-layout
- Update class overview pages to include constructor/destructor entries
 2026-03-22 03:07:41 +08:00
ssdfasd
1358bb0a5a docs: 修复 D3D12 后端 API 文档问题 
- 修复 texture/dtor.md 和 enums/enums.md 的错误链接
- 重命名 texture/ctor.md → constructor.md, texture/dtor.md → destructor.md
- 创建 command-list, fence, device, query-heap, sampler 的 constructor/destructor 文档
- 创建 D3D12Texture 缺失的 16 个方法文档
- 创建 D3D12CommandList 缺失的 12 个 internal 方法文档
- 补充 shader-resource-view 缺少的头文件和类型字段
 2026-03-22 02:08:51 +08:00
ssdfasd
629455df07 Update API documentation and remove obsolete plan files 2026-03-21 15:55:04 +08:00
ssdfasd
26fe3cd835 D3D12: Add bounds check to GetBackBuffer and update unit tests 
- Add assert() bounds check to GetBackBuffer() to catch invalid indices
- Include <cassert> in D3D12SwapChain.cpp
- Update test_swap_chain.cpp to use reference return type
- Mark InvalidIndex test as DISABLED (assert aborts on invalid index)
- Update get-back-buffer.md documentation
 2026-03-20 18:35:00 +08:00
ssdfasd
070b444f8f docs: update RHI API docs 2026-03-20 02:35:45 +08:00
ssdfasd
5257f3d75c docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法 2026-03-19 02:01:18 +08:00
ssdfasd
8e85fd98b8 docs: Remove sub-headers from 公共方法 sections to follow SKILL.md规范 2026-03-19 01:59:38 +08:00
ssdfasd
b46d450429 Fix RHI documentation discrepancies 
Fixed the following issues:
- command-list.md: Shutdown linked to threading/task-system instead of local shutdown.md
- fence.md: Wait linked to threading/task-group instead of local wait.md
- factory/create-rhi-device-string.md: Claimed Vulkan/Metal support but source doesn't support them
- opengl/buffer/buffer.md: GetType linked to command-queue/get-type (wrong type)
- d3d12/device/device.md: Initialize/Shutdown linked to threading/task-system
- d3d12/command-list/command-list.md: Initialize/Shutdown/Reset/Close/Clear linked to wrong docs
- d3d12/texture/texture.md: Initialize/Shutdown linked to threading/task-system
- opengl/command-list/command-list.md: Shutdown linked to threading/task-system
- opengl/device/device.md: GetNativeHandle incorrectly linked to get-window.md

All links validated with fix_links.py - no broken references remaining.
 2026-03-19 01:23:10 +08:00
ssdfasd
2141534995 docs: Fix RHI module documentation discrepancies 
Fixed incorrect links in RHI documentation:
- Fixed OpenGL swap-chain docs with wrong references to threading/containers
- Fixed OpenGL texture docs with incorrect buffer/ texture links
- Fixed OpenGL vertex-array docs with wrong threading links
- Fixed OpenGL sampler docs with wrong threading links
- Fixed OpenGL device docs with incorrect swap-chain links
- Fixed fence docs with incorrect command-queue links
- Fixed command-list docs with missing shutdown link
- Fixed get-framebuffer-size.md title mismatch

Added missing documentation:
- Created fence/wait.md
- Created command-list/shutdown.md
- Created swap-chain/resize.md
- Created OpenGL sampler initialize.md, bind.md, unbind.md
 2026-03-19 01:07:49 +08:00
ssdfasd
a669ec819d Fix RHI documentation discrepancies and add missing doc files 
Fixed incorrect links in OpenGL documentation:
- Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods
- Fixed wrong links to buffer docs for GetNativeHandle methods
- Fixed wrong links to shader docs for Bind/Unbind methods
- Fixed wrong links to command-list docs for Clear/Reset/Close methods
- Fixed wrong links to buffer/get-size.md for width/height methods

Added missing documentation files:
- OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md
- OpenGL fence: initialize.md, reset.md
- OpenGL swap-chain: get-size.md, initialize.md
- OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md
- OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md
- OpenGL command-list: clear.md

All links validated with fix_links.py - no broken references.
 2026-03-19 00:54:54 +08:00
ssdfasd
82cf147817 docs: 修正 API 文档准确性 (第四轮检查) 
修复问题:
- containers: HashMap 实现描述修正
- debug: XE_LOG 宏参数顺序修正
- memory: ProxyAllocator 统计示例修正, PoolAllocator allocate size 检查描述
- resources: ResourceManager 缺失 UnloadGroup 方法
- rhi: D3D12 格式枚举名称修正, Texture Format 枚举补全, ResourceStates 补充
- threading: TaskGroup GetProgress/Wait/Cancel 实现限制说明
 2026-03-19 00:43:16 +08:00
ssdfasd
870cb3116e docs: 修正 API 文档准确性 (第三轮检查) 
修复问题:
- containers: HashMap include 路径修复
- core: RefCounted 析构函数访问级别, Event::begin/end 返回值说明
- memory: LinearAllocator::GetMarker 返回偏移量非指针
- resources: LoadAsync 示例使用不存在的模板方法
- rhi: OpenGL 链接错误, ShaderType 枚举缺失8个类型, 链接修复
- threading: SpinLock STL 兼容方法说明, Mutex const 方法说明
 2026-03-19 00:35:26 +08:00
ssdfasd
a9f882f233 docs: 修正 API 文档准确性 (第二轮检查) 
修复的问题:
- math: 修复 Quaternion::Normalize 链接错误
- containers: HashMap 迭代器示例使用不存在的 cbegin/cend，删除冗余构造函数声明
- core: RefCounted 析构函数访问级别修正 (protected)
- debug: LogLevelToString 示例返回值大小写修正
- memory: 修正 LinearAllocator::Reallocate 返回 nullptr，ProxyAllocator 统计描述，头文件路径 IAllocator.h -> Allocator.h
- resources: Texture::Create mipLevels 参数描述修正
- rhi: 修复多处链接错误，新增缺失的方法文档
- threading: TaskSystem 配置项未实现状态标注，Wait 方法空实现标注
 2026-03-19 00:31:14 +08:00
ssdfasd
dc850d7739 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 个断裂引用
 2026-03-19 00:22:30 +08:00
ssdfasd
9bad996ecf refactor: reorganize docs into plan/ and add skills/ 2026-03-18 17:49:22 +08:00