vkGetPhysicalDeviceExternalImageFormatPropertiesNV(3)

Name

vkGetPhysicalDeviceExternalImageFormatPropertiesNV - Determine image capabilities compatible with external memory handle types

C Specification

To determine the image capabilities compatible with an external memory handle type, call:

// Provided by VK_NV_external_memory_capabilities
VkResult vkGetPhysicalDeviceExternalImageFormatPropertiesNV(
    VkPhysicalDevice                            physicalDevice,
    VkFormat                                    format,
    VkImageType                                 type,
    VkImageTiling                               tiling,
    VkImageUsageFlags                           usage,
    VkImageCreateFlags                          flags,
    VkExternalMemoryHandleTypeFlagsNV           externalHandleType,
    VkExternalImageFormatPropertiesNV*          pExternalImageFormatProperties);

Parameters

physicalDevice is the physical device from which to query the image capabilities
format is the image format, corresponding to VkImageCreateInfo::format.
type is the image type, corresponding to VkImageCreateInfo::imageType.
tiling is the image tiling, corresponding to VkImageCreateInfo::tiling.
usage is the intended usage of the image, corresponding to VkImageCreateInfo::usage.
flags is a bitmask describing additional parameters of the image, corresponding to VkImageCreateInfo::flags.
externalHandleType is either one of the bits from VkExternalMemoryHandleTypeFlagBitsNV, or 0.
pExternalImageFormatProperties is a pointer to a VkExternalImageFormatPropertiesNV structure in which capabilities are returned.

Description

If externalHandleType is 0, pExternalImageFormatProperties->imageFormatProperties will return the same values as a call to vkGetPhysicalDeviceImageFormatProperties, and the other members of pExternalImageFormatProperties will all be 0. Otherwise, they are filled in as described for VkExternalImageFormatPropertiesNV.

Valid Usage

VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-externalHandleType-07721
externalHandleType must not have more than one bit set

Valid Usage (Implicit)

VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-physicalDevice-parameter
physicalDevice must be a valid VkPhysicalDevice handle
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-format-parameter
format must be a valid VkFormat value
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-type-parameter
type must be a valid VkImageType value
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-tiling-parameter
tiling must be a valid VkImageTiling value
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-usage-parameter
usage must be a valid combination of VkImageUsageFlagBits values
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-usage-requiredbitmask
usage must not be 0
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-flags-parameter
flags must be a valid combination of VkImageCreateFlagBits values
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-externalHandleType-parameter
externalHandleType must be a valid combination of VkExternalMemoryHandleTypeFlagBitsNV values
VUID-vkGetPhysicalDeviceExternalImageFormatPropertiesNV-pExternalImageFormatProperties-parameter
pExternalImageFormatProperties must be a valid pointer to a VkExternalImageFormatPropertiesNV structure

Return Codes

Success

VK_SUCCESS

Failure

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.