VulkanHub
Structures

VkFenceGetFdInfoKHR

Structure describing a POSIX FD fence export operation

The VkFenceGetFdInfoKHR structure is defined as:

typedef struct VkFenceGetFdInfoKHR {
    VkStructureType sType;
    const void* pNext;
    VkFence fence;
    VkExternalFenceHandleTypeFlagBits handleType;
} VkFenceGetFdInfoKHR;
  • sType is a VkStructureType value identifying this structure.
  • pNext is NULL or a pointer to a structure extending this structure.
  • fence is the fence from which state will be exported.
  • handleType is a VkExternalFenceHandleTypeFlagBits value specifying the type of handle requested.

The properties of the file descriptor returned depend on the value of handleType. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

Valid Usage

VUID-VkFenceGetFdInfoKHR-handleType-01453

handleType must have been included in VkExportFenceCreateInfo::handleTypes when fence’s current payload was created

VUID-VkFenceGetFdInfoKHR-handleType-01454

If handleType refers to a handle type with copy payload transference semantics, fence must be signaled, or have an associated fence signal operation pending execution

VUID-VkFenceGetFdInfoKHR-fence-01455

fence must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in VkExternalFenceProperties::exportFromImportedHandleTypes for handleType

VUID-VkFenceGetFdInfoKHR-handleType-01456

handleType must be defined as a POSIX file descriptor handle

Valid Usage (Implicit)

VUID-VkFenceGetFdInfoKHR-sType-sType

sType must be VK_STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

VUID-VkFenceGetFdInfoKHR-pNext-pNext

pNext must be NULL

VUID-VkFenceGetFdInfoKHR-fence-parameter

fence must be a valid VkFence handle

VUID-VkFenceGetFdInfoKHR-handleType-parameter

handleType must be a valid VkExternalFenceHandleTypeFlagBits value