vkGetDeviceQueue(3)

Name

vkGetDeviceQueue - Get a queue handle from a device

C Specification

To retrieve a handle to aVkQueue object, call:

// Provided by VK_VERSION_1_0void vkGetDeviceQueue(    VkDevice                                    device,    uint32_t                                    queueFamilyIndex,    uint32_t                                    queueIndex,    VkQueue*                                    pQueue);

Parameters

device is the logical device that owns the queue.
queueFamilyIndex is the index of the queue family to which thequeue belongs.
queueIndex is the index within this queue family of the queue toretrieve.
pQueue is a pointer to aVkQueue object that will be filledwith the handle for the requested queue.

Description

vkGetDeviceQueuemust only be used to get queues that were createdwith theflags parameter ofVkDeviceQueueCreateInfo set to zero.To get queues that were created with a non-zeroflags parameter usevkGetDeviceQueue2.

Valid Usage

VUID-vkGetDeviceQueue-queueFamilyIndex-00384
queueFamilyIndexmust be one of the queue family indicesspecified whendevice was created, via theVkDeviceQueueCreateInfo structure
VUID-vkGetDeviceQueue-queueIndex-00385
queueIndexmust be less than the value ofVkDeviceQueueCreateInfo::queueCount for the queue familyindicated byqueueFamilyIndex whendevice was created
VUID-vkGetDeviceQueue-flags-01841
VkDeviceQueueCreateInfo::flagsmust have been zero whendevice was created

Valid Usage (Implicit)

VUID-vkGetDeviceQueue-device-parameter
devicemust be a validVkDevice handle
VUID-vkGetDeviceQueue-pQueue-parameter
pQueuemust be a valid pointer to aVkQueue handle

Document Notes

For more information, see theVulkan Specification.

This page is extracted from the Vulkan Specification.Fixes and changes should be made to the Specification, not directly.

Movatterモバイル変換