vulkan: document flags choice for vkGetDeviceQueue

Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/9053>

diff --git a/src/vulkan/util/vk_device.c b/src/vulkan/util/vk_device.c
index 44df409..cfaebc5 100644 (file)
--- a/src/vulkan/util/vk_device.c
+++ b/src/vulkan/util/vk_device.c
@@ -131,6 +131,13 @@ vk_common_GetDeviceQueue(VkDevice _device,
    const VkDeviceQueueInfo2 info = {
       .sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_INFO_2,
       .pNext = NULL,
+      /* flags = 0 because (Vulkan spec 1.2.170 - vkGetDeviceQueue):
+       *
+       *    "vkGetDeviceQueue must only be used to get queues that were
+       *     created with the flags parameter of VkDeviceQueueCreateInfo set
+       *     to zero. To get queues that were created with a non-zero flags
+       *     parameter use vkGetDeviceQueue2."
+       */
       .flags = 0,
       .queueFamilyIndex = queueFamilyIndex,
       .queueIndex = queueIndex,