Skip to content

Commit 34e8825

Browse files
committed
Merge pull request #108906 from maidopi-usagi/drvres_doc
Update documentation for `DriverResource` enum .
2 parents f445b92 + 7cb1598 commit 34e8825

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

doc/classes/RenderingDevice.xml

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,35 +1146,41 @@
11461146
Represents the size of the [enum DeviceType] enum.
11471147
</constant>
11481148
<constant name="DRIVER_RESOURCE_LOGICAL_DEVICE" value="0" enum="DriverResource">
1149-
Specific device object based on a physical device.
1150-
- Vulkan: Vulkan device driver resource ([code]VkDevice[/code]) ([code]rid[/code] parameter is ignored).
1149+
Specific device object based on a physical device ([code]rid[/code] parameter is ignored).
1150+
- Vulkan: Vulkan device driver resource ([code]VkDevice[/code]).
1151+
- D3D12: D3D12 device driver resource ([code]ID3D12Device[/code]).
1152+
- Metal: Metal device driver resource ([code]MTLDevice[/code]).
11511153
</constant>
11521154
<constant name="DRIVER_RESOURCE_PHYSICAL_DEVICE" value="1" enum="DriverResource">
1153-
Physical device the specific logical device is based on.
1154-
- Vulkan: [code]VkDevice[/code] ([code]rid[/code] parameter is ignored).
1155+
Physical device the specific logical device is based on ([code]rid[/code] parameter is ignored).
1156+
- Vulkan: [code]VkPhysicalDevice[/code].
1157+
- D3D12: [code]IDXGIAdapter[/code].
11551158
</constant>
11561159
<constant name="DRIVER_RESOURCE_TOPMOST_OBJECT" value="2" enum="DriverResource">
1157-
Top-most graphics API entry object.
1158-
- Vulkan: [code]VkInstance[/code] ([code]rid[/code] parameter is ignored).
1160+
Top-most graphics API entry object ([code]rid[/code] parameter is ignored).
1161+
- Vulkan: [code]VkInstance[/code].
11591162
</constant>
11601163
<constant name="DRIVER_RESOURCE_COMMAND_QUEUE" value="3" enum="DriverResource">
1161-
The main graphics-compute command queue.
1162-
- Vulkan: [code]VkQueue[/code] ([code]rid[/code] parameter is ignored).
1164+
The main graphics-compute command queue ([code]rid[/code] parameter is ignored).
1165+
- Vulkan: [code]VkQueue[/code].
1166+
- Metal: [code]MTLCommandQueue[/code].
11631167
</constant>
11641168
<constant name="DRIVER_RESOURCE_QUEUE_FAMILY" value="4" enum="DriverResource">
1165-
The specific family the main queue belongs to.
1166-
- Vulkan: The queue family index, a [code]uint32_t[/code] ([code]rid[/code] parameter is ignored).
1169+
The specific family the main queue belongs to ([code]rid[/code] parameter is ignored).
1170+
- Vulkan: The queue family index, a [code]uint32_t[/code].
11671171
</constant>
11681172
<constant name="DRIVER_RESOURCE_TEXTURE" value="5" enum="DriverResource">
11691173
- Vulkan: [code]VkImage[/code].
11701174
</constant>
11711175
<constant name="DRIVER_RESOURCE_TEXTURE_VIEW" value="6" enum="DriverResource">
11721176
The view of an owned or shared texture.
11731177
- Vulkan: [code]VkImageView[/code].
1178+
- D3D12: [code]ID3D12Resource[/code].
11741179
</constant>
11751180
<constant name="DRIVER_RESOURCE_TEXTURE_DATA_FORMAT" value="7" enum="DriverResource">
11761181
The native id of the data format of the texture.
11771182
- Vulkan: [code]VkFormat[/code].
1183+
- D3D12: [code]DXGI_FORMAT[/code].
11781184
</constant>
11791185
<constant name="DRIVER_RESOURCE_SAMPLER" value="8" enum="DriverResource">
11801186
- Vulkan: [code]VkSampler[/code].
@@ -1185,12 +1191,15 @@
11851191
<constant name="DRIVER_RESOURCE_BUFFER" value="10" enum="DriverResource">
11861192
Buffer of any kind of (storage, vertex, etc.).
11871193
- Vulkan: [code]VkBuffer[/code].
1194+
- D3D12: [code]ID3D12Resource[/code].
11881195
</constant>
11891196
<constant name="DRIVER_RESOURCE_COMPUTE_PIPELINE" value="11" enum="DriverResource">
11901197
- Vulkan: [code]VkPipeline[/code].
1198+
- Metal: [code]MTLComputePipelineState[/code].
11911199
</constant>
11921200
<constant name="DRIVER_RESOURCE_RENDER_PIPELINE" value="12" enum="DriverResource">
11931201
- Vulkan: [code]VkPipeline[/code].
1202+
- Metal: [code]MTLRenderPipelineState[/code].
11941203
</constant>
11951204
<constant name="DRIVER_RESOURCE_VULKAN_DEVICE" value="0" enum="DriverResource" deprecated="Use [constant DRIVER_RESOURCE_LOGICAL_DEVICE] instead.">
11961205
</constant>

0 commit comments

Comments
 (0)