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.
This commit is contained in:
@@ -81,7 +81,7 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
| `Shutdown` | [详细文档](shutdown.md) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -10,10 +10,9 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
|
||||
| `Close` | [详细文档](../../../core/filewriter/close.md) |
|
||||
| `Shutdown` | [详细文档](../../command-list/shutdown.md) |
|
||||
| `Reset` | [详细文档](../../command-list/reset.md) |
|
||||
| `Close` | [详细文档](../../command-list/close.md) |
|
||||
| `GetCommandList` | [详细文档](get-command-list.md) |
|
||||
|
||||
### 资源屏障
|
||||
@@ -97,7 +96,7 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Clear` | [详细文档](../../../memory/linear-allocator/clear.md) |
|
||||
| `Clear` | [详细文档](../../command-list/clear.md) |
|
||||
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
|
||||
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
||||
|
||||
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Initialize` | [详细文档](../../device/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../device/shutdown.md) |
|
||||
| `CreateBuffer` | [详细文档](../../device/create-buffer.md) |
|
||||
| `CreateTexture` | [详细文档](../../device/create-texture.md) |
|
||||
| `CreateSwapChain` | [详细文档](../../device/create-swap-chain.md) |
|
||||
|
||||
@@ -8,11 +8,10 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `InitializeFromExisting` | [详细文档](../buffer/initialize-from-existing.md) |
|
||||
| `InitializeFromData` | [详细文档](initialize-from-data.md) |
|
||||
| `InitializeDepthStencil` | [详细文档](initialize-depth-stencil.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Shutdown` | [详细文档](../../texture/shutdown.md) |
|
||||
| `GetResource` | [详细文档](../buffer/get-resource.md) |
|
||||
| `GetDesc` | [详细文档](../buffer/get-desc.md) |
|
||||
| `GetWidth` | [详细文档](../../texture/get-width.md) |
|
||||
|
||||
@@ -15,9 +15,8 @@ static RHIDevice* CreateRHIDevice(const std::string& typeName);
|
||||
|
||||
**支持的类型名称:**
|
||||
- `"D3D12"` / `"d3d12"`
|
||||
- `"OpenGL"` / `"opengl"`
|
||||
- `"Vulkan"` / `"vulkan"`
|
||||
- `"Metal"` / `"metal"`
|
||||
- `"OpenGL"` / `"opengl"` / `"GL"`
|
||||
- Vulkan 和 Metal 暂不支持
|
||||
|
||||
**示例:**
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Signal` | [详细文档](signal.md) |
|
||||
| `Wait` | [详细文档](../../threading/task-group/wait.md) |
|
||||
| `Wait` | [详细文档](wait.md) |
|
||||
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
|
||||
| `IsSignaled` | [详细文档](is-signaled.md) |
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
| `SetData` | [详细文档](../../buffer/set-data.md) |
|
||||
| `GetID` | [详细文档](get-id.md) |
|
||||
| `GetSize` | [详细文档](../../buffer/get-size.md) |
|
||||
| `GetType` | [详细文档](../../command-queue/get-type.md) |
|
||||
| `GetType` | [详细文档](get-type.md) |
|
||||
| `IsDynamic` | [详细文档](is-dynamic.md) |
|
||||
| `GetBufferType` / `SetBufferType` | [详细文档](../../buffer/get-buffer-type.md) |
|
||||
| `GetStride` / `SetStride` | [详细文档](../../buffer/get-stride.md) |
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Shutdown` | [详细文档](../../command-list/shutdown.md) |
|
||||
| `Reset` | [详细文档](../../command-list/reset.md) |
|
||||
| `Close` | [详细文档](../../command-list/close.md) |
|
||||
| `Clear` | [详细文档](clear.md) |
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
| `GetCapabilities` | [详细文档](../../device/get-capabilities.md) |
|
||||
| `GetDeviceInfo` | [详细文档](../../device/get-device-info.md) |
|
||||
| `GetNativeDevice` | [详细文档](../../device/get-native-device.md) |
|
||||
| `GetNativeHandle` | [详细文档](get-window.md) |
|
||||
| `GetNativeHandle` | [详细文档](../../device/get-native-device.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
|
||||
Reference in New Issue
Block a user