Class VkImportFenceFdInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkImportFenceFdInfoKHR
    extends Struct
    implements NativeResource
    (None).
    Description

    The handle types supported by handleType are:

    Handle Types Supported by VkImportFenceFdInfoKHR
    Handle TypeTransferencePermanence Supported
    EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BITReferenceTemporary,Permanent
    EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BITCopyTemporary
    Valid Usage

    If handleType is EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT, the special value -1 for fd is treated like a valid sync file descriptor referring to an object that has already signaled. The import operation will succeed and the VkFence will have a temporarily imported payload as if a valid file descriptor had been provided.

    Note

    This special behavior for importing an invalid sync file descriptor allows easier interoperability with other system APIs which use the convention that an invalid sync file descriptor represents work that has already completed and does not need to be waited for. It is consistent with the option for implementations to return a -1 file descriptor when exporting a EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT from a VkFence which is signaled.

    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR
    • pNext must be NULL
    • fence must be a valid VkFence handle
    • flags must be a valid combination of VkFenceImportFlagBits values
    • handleType must be a valid VkExternalFenceHandleTypeFlagBits value
    Host Synchronization
    • Host access to fence must be externally synchronized
    See Also

    ImportFenceFdKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • fence – the fence into which the payload will be imported.
    • flags – a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.
    • handleType – specifies the type of fd.
    • fd – the external handle to import.

    Layout

    
     struct VkImportFenceFdInfoKHR {
         VkStructureType sType;
         void const * pNext;
         VkFence fence;
         VkFenceImportFlags flags;
         VkExternalFenceHandleTypeFlagBits handleType;
         int fd;
     }