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:
143
docs/api/rhi/d3d12/command-list/command-list.md
Normal file
143
docs/api/rhi/d3d12/command-list/command-list.md
Normal file
@@ -0,0 +1,143 @@
|
||||
# D3D12CommandList
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 命令列表的 D3D12 实现,继承自 `RHICommandList`。
|
||||
|
||||
## 方法列表
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
|
||||
| `Close` | [详细文档](../../../core/filewriter/close.md) |
|
||||
| `GetCommandList` | [详细文档](get-command-list.md) |
|
||||
|
||||
### 资源屏障
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `TransitionBarrier` | [详细文档](transition-barrier.md) |
|
||||
| `TransitionBarrierInternal` | [详细文档](transition-barrier-internal.md) |
|
||||
| `UAVBarrier` | [详细文档](uav-barrier.md) |
|
||||
| `AliasBarrier` | [详细文档](alias-barrier.md) |
|
||||
|
||||
### 管线状态
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetPipelineState` | [详细文档](set-pipeline-state.md) |
|
||||
| `SetRootSignature` | [详细文档](set-root-signature.md) |
|
||||
| `SetPrimitiveTopology` | [详细文档](set-primitive-topology.md) |
|
||||
|
||||
### 视口与裁剪
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetViewport` | [详细文档](set-viewport.md) |
|
||||
| `SetViewports` | [详细文档](set-viewports.md) |
|
||||
| `SetScissorRect` | [详细文档](set-scissor-rect.md) |
|
||||
| `SetScissorRects` | [详细文档](set-scissor-rects.md) |
|
||||
|
||||
### 渲染目标
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetRenderTargets` | [详细文档](set-render-targets.md) |
|
||||
| `SetRenderTargetsInternal` | [详细文档](set-render-targets-internal.md) |
|
||||
| `SetRenderTargetsHandle` | [详细文档](set-render-targets-handle.md) |
|
||||
|
||||
### 顶点/索引缓冲区
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) |
|
||||
| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) |
|
||||
| `SetIndexBuffer` | [详细文档](set-index-buffer.md) |
|
||||
|
||||
### 描述符
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetDescriptorHeap` | [详细文档](set-descriptor-heap.md) |
|
||||
| `SetDescriptorHeaps` | [详细文档](set-descriptor-heaps.md) |
|
||||
| `SetGraphicsDescriptorTable` | [详细文档](set-graphics-descriptor-table.md) |
|
||||
| `SetComputeDescriptorTable` | [详细文档](set-compute-descriptor-table.md) |
|
||||
|
||||
### 根参数绑定
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetGraphicsRootConstantBufferView` | [详细文档](set-graphics-root-constant-buffer-view.md) |
|
||||
| `SetGraphicsRoot32BitConstants` | [详细文档](set-graphics-root-32bit-constants.md) |
|
||||
| `SetGraphicsRootDescriptorTable` | [详细文档](set-graphics-root-descriptor-table.md) |
|
||||
| `SetGraphicsRootShaderResourceView` | [详细文档](set-graphics-root-shader-resource-view.md) |
|
||||
|
||||
### 渲染状态
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetStencilRef` | [详细文档](set-stencil-ref.md) |
|
||||
| `SetBlendFactor` | [详细文档](set-blend-factor.md) |
|
||||
| `SetDepthBias` | [详细文档](set-depth-bias.md) |
|
||||
|
||||
### 绘制
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Draw` | [详细文档](draw.md) |
|
||||
| `DrawIndexed` | [详细文档](draw-indexed.md) |
|
||||
| `DrawInstancedIndirect` | [详细文档](draw-instanced-indirect.md) |
|
||||
| `DrawIndexedInstancedIndirect` | [详细文档](draw-indexed-instanced-indirect.md) |
|
||||
|
||||
### 清除
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Clear` | [详细文档](../../../memory/linear-allocator/clear.md) |
|
||||
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
|
||||
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
||||
|
||||
### 复制
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `CopyResource` | [详细文档](copy-resource.md) |
|
||||
| `CopyBuffer` | [详细文档](copy-buffer.md) |
|
||||
| `CopyTexture` | [详细文档](copy-texture.md) |
|
||||
|
||||
### 查询
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `BeginQuery` | [详细文档](begin-query.md) |
|
||||
| `EndQuery` | [详细文档](end-query.md) |
|
||||
| `ResolveQueryData` | [详细文档](resolve-query-data.md) |
|
||||
|
||||
### 计算
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Dispatch` | [详细文档](dispatch.md) |
|
||||
| `DispatchIndirect` | [详细文档](dispatch-indirect.md) |
|
||||
|
||||
### Bundle
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `ExecuteBundle` | [详细文档](execute-bundle.md) |
|
||||
|
||||
### 状态管理
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetResourceState` | [详细文档](get-resource-state.md) |
|
||||
| `TrackResource` | [详细文档](track-resource.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../overview.md)
|
||||
- [RHICommandList](../../command-list/command-list.md) - 抽象命令列表接口
|
||||
Reference in New Issue
Block a user