vkCreateExternalComputeQueueNV(3)

Name

vkCreateExternalComputeQueueNV - Create an external compute queue for use by a compatible external API.

C Specification

To create an external compute queue for use by compatible external APIs call:

// Provided by VK_NV_external_compute_queue
VkResult vkCreateExternalComputeQueueNV(
    VkDevice                                    device,
    const VkExternalComputeQueueCreateInfoNV*   pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkExternalComputeQueueNV*                   pExternalQueue);

Parameters

  • device is the VkDevice that the external queue will be a part of.

  • pCreateInfo is a pointer to a VkExternalComputeQueueCreateInfoNV structure specifying configuration info for creating the external queue.

  • pAllocator controls host memory allocation as described in the Memory Allocation chapter.

  • pExternalQueue is a pointer to a VkExternalComputeQueueNV object that will be filled with the handle for the created external queue.

Description

Valid Usage (Implicit)

  • VUID-vkCreateExternalComputeQueueNV-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkCreateExternalComputeQueueNV-pCreateInfo-parameter
    pCreateInfo must be a valid pointer to a valid VkExternalComputeQueueCreateInfoNV structure

  • VUID-vkCreateExternalComputeQueueNV-pAllocator-parameter
    If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

  • VUID-vkCreateExternalComputeQueueNV-pExternalQueue-parameter
    pExternalQueue must be a valid pointer to a VkExternalComputeQueueNV handle

  • VUID-vkCreateExternalComputeQueueNV-device-queuecount
    The device must have been created with at least 1 queue

Return Codes
Success

  • VK_SUCCESS

Failure

  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_TOO_MANY_OBJECTS

  • VK_ERROR_UNKNOWN

  • VK_ERROR_VALIDATION_FAILED

See Also

VK_NV_external_compute_queue, VkAllocationCallbacks, VkDevice, VkExternalComputeQueueCreateInfoNV, VkExternalComputeQueueNV

Document Notes

For more information, see the Vulkan Specification.

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