Update descriptions for driver resource enums .

This commit is contained in:
MaidOpi 2025-07-24 01:11:59 +08:00
parent 037956dbc9
commit 7cb1598d64

View file

@ -1146,24 +1146,28 @@
Represents the size of the [enum DeviceType] enum. Represents the size of the [enum DeviceType] enum.
</constant> </constant>
<constant name="DRIVER_RESOURCE_LOGICAL_DEVICE" value="0" enum="DriverResource"> <constant name="DRIVER_RESOURCE_LOGICAL_DEVICE" value="0" enum="DriverResource">
Specific device object based on a physical device. Specific device object based on a physical device ([code]rid[/code] parameter is ignored).
- Vulkan: Vulkan device driver resource ([code]VkDevice[/code]) ([code]rid[/code] parameter is ignored). - Vulkan: Vulkan device driver resource ([code]VkDevice[/code]).
- D3D12: D3D12 device driver resource ([code]ID3D12Device[/code]).
- Metal: Metal device driver resource ([code]MTLDevice[/code]).
</constant> </constant>
<constant name="DRIVER_RESOURCE_PHYSICAL_DEVICE" value="1" enum="DriverResource"> <constant name="DRIVER_RESOURCE_PHYSICAL_DEVICE" value="1" enum="DriverResource">
Physical device the specific logical device is based on. Physical device the specific logical device is based on ([code]rid[/code] parameter is ignored).
- Vulkan: [code]VkDevice[/code] ([code]rid[/code] parameter is ignored). - Vulkan: [code]VkPhysicalDevice[/code].
- D3D12: [code]IDXGIAdapter[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_TOPMOST_OBJECT" value="2" enum="DriverResource"> <constant name="DRIVER_RESOURCE_TOPMOST_OBJECT" value="2" enum="DriverResource">
Top-most graphics API entry object. Top-most graphics API entry object ([code]rid[/code] parameter is ignored).
- Vulkan: [code]VkInstance[/code] ([code]rid[/code] parameter is ignored). - Vulkan: [code]VkInstance[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_COMMAND_QUEUE" value="3" enum="DriverResource"> <constant name="DRIVER_RESOURCE_COMMAND_QUEUE" value="3" enum="DriverResource">
The main graphics-compute command queue. The main graphics-compute command queue ([code]rid[/code] parameter is ignored).
- Vulkan: [code]VkQueue[/code] ([code]rid[/code] parameter is ignored). - Vulkan: [code]VkQueue[/code].
- Metal: [code]MTLCommandQueue[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_QUEUE_FAMILY" value="4" enum="DriverResource"> <constant name="DRIVER_RESOURCE_QUEUE_FAMILY" value="4" enum="DriverResource">
The specific family the main queue belongs to. The specific family the main queue belongs to ([code]rid[/code] parameter is ignored).
- Vulkan: The queue family index, a [code]uint32_t[/code] ([code]rid[/code] parameter is ignored). - Vulkan: The queue family index, a [code]uint32_t[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_TEXTURE" value="5" enum="DriverResource"> <constant name="DRIVER_RESOURCE_TEXTURE" value="5" enum="DriverResource">
- Vulkan: [code]VkImage[/code]. - Vulkan: [code]VkImage[/code].
@ -1171,10 +1175,12 @@
<constant name="DRIVER_RESOURCE_TEXTURE_VIEW" value="6" enum="DriverResource"> <constant name="DRIVER_RESOURCE_TEXTURE_VIEW" value="6" enum="DriverResource">
The view of an owned or shared texture. The view of an owned or shared texture.
- Vulkan: [code]VkImageView[/code]. - Vulkan: [code]VkImageView[/code].
- D3D12: [code]ID3D12Resource[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_TEXTURE_DATA_FORMAT" value="7" enum="DriverResource"> <constant name="DRIVER_RESOURCE_TEXTURE_DATA_FORMAT" value="7" enum="DriverResource">
The native id of the data format of the texture. The native id of the data format of the texture.
- Vulkan: [code]VkFormat[/code]. - Vulkan: [code]VkFormat[/code].
- D3D12: [code]DXGI_FORMAT[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_SAMPLER" value="8" enum="DriverResource"> <constant name="DRIVER_RESOURCE_SAMPLER" value="8" enum="DriverResource">
- Vulkan: [code]VkSampler[/code]. - Vulkan: [code]VkSampler[/code].
@ -1185,12 +1191,15 @@
<constant name="DRIVER_RESOURCE_BUFFER" value="10" enum="DriverResource"> <constant name="DRIVER_RESOURCE_BUFFER" value="10" enum="DriverResource">
Buffer of any kind of (storage, vertex, etc.). Buffer of any kind of (storage, vertex, etc.).
- Vulkan: [code]VkBuffer[/code]. - Vulkan: [code]VkBuffer[/code].
- D3D12: [code]ID3D12Resource[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_COMPUTE_PIPELINE" value="11" enum="DriverResource"> <constant name="DRIVER_RESOURCE_COMPUTE_PIPELINE" value="11" enum="DriverResource">
- Vulkan: [code]VkPipeline[/code]. - Vulkan: [code]VkPipeline[/code].
- Metal: [code]MTLComputePipelineState[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_RENDER_PIPELINE" value="12" enum="DriverResource"> <constant name="DRIVER_RESOURCE_RENDER_PIPELINE" value="12" enum="DriverResource">
- Vulkan: [code]VkPipeline[/code]. - Vulkan: [code]VkPipeline[/code].
- Metal: [code]MTLRenderPipelineState[/code].
</constant> </constant>
<constant name="DRIVER_RESOURCE_VULKAN_DEVICE" value="0" enum="DriverResource" deprecated="Use [constant DRIVER_RESOURCE_LOGICAL_DEVICE] instead."> <constant name="DRIVER_RESOURCE_VULKAN_DEVICE" value="0" enum="DriverResource" deprecated="Use [constant DRIVER_RESOURCE_LOGICAL_DEVICE] instead.">
</constant> </constant>