Package org.lwjgl.vulkan

Class VkImportFenceFdInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkImportFenceFdInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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

    Layout

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

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, FENCE, FLAGS, HANDLETYPE, FD

        The struct member offsets.

    • Constructor Detail

      • VkImportFenceFdInfoKHR

        public VkImportFenceFdInfoKHR​(java.nio.ByteBuffer container)
        Creates a VkImportFenceFdInfoKHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • sType

        public int sType()
        the type of this structure.

      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.

      • fence

        public long fence()
        the fence into which the payload will be imported.

      • flags

        public int flags()
        a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.

      • handleType

        public int handleType()
        a VkExternalFenceHandleTypeFlagBits value specifying the type of fd.

      • fd

        public int fd()
        the external handle to import.

      • set

        public VkImportFenceFdInfoKHR set​(int sType,
                                  long pNext,
                                  long fence,
                                  int flags,
                                  int handleType,
                                  int fd)
        Initializes this struct with the specified values.

      • malloc

        public static VkImportFenceFdInfoKHR malloc()
        Returns a new VkImportFenceFdInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkImportFenceFdInfoKHR calloc()
        Returns a new VkImportFenceFdInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkImportFenceFdInfoKHR create()
        Returns a new VkImportFenceFdInfoKHR instance allocated with BufferUtils.

      • create

        public static VkImportFenceFdInfoKHR create​(long address)
        Returns a new VkImportFenceFdInfoKHR instance for the specified memory address.

      • createSafe

        @Nullable
public static VkImportFenceFdInfoKHR createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

        public static VkImportFenceFdInfoKHR malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkImportFenceFdInfoKHR calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkImportFenceFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • malloc

        public static VkImportFenceFdInfoKHR.Buffer malloc​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

        public static VkImportFenceFdInfoKHR.Buffer calloc​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Returns a new VkImportFenceFdInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().

      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().

      • nfence

        public static long nfence​(long struct)
        Unsafe version of fence().

      • nflags

        public static int nflags​(long struct)
        Unsafe version of flags().

      • nhandleType

        public static int nhandleType​(long struct)
        Unsafe version of handleType().

      • nfd

        public static int nfd​(long struct)
        Unsafe version of fd().

      • nsType

        public static void nsType​(long struct,
                          int value)
        Unsafe version of sType.

      • npNext

        public static void npNext​(long struct,
                          long value)
        Unsafe version of pNext.

      • nfence

        public static void nfence​(long struct,
                          long value)
        Unsafe version of fence.

      • nflags

        public static void nflags​(long struct,
                          int value)
        Unsafe version of flags.

      • nhandleType

        public static void nhandleType​(long struct,
                               int value)
        Unsafe version of handleType.

      • nfd

        public static void nfd​(long struct,
                       int value)
        Unsafe version of fd.