Class VkSemaphoreGetFdInfoKHR

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

    public class VkSemaphoreGetFdInfoKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure describing a POSIX FD semaphore export operation.
    Description

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

    Valid Usage
    • handleType must have been included in VkExportSemaphoreCreateInfo::handleTypes when semaphore’s current payload was created.
    • semaphore must not currently have its payload replaced by an imported payload as described below in Importing Semaphore Payloads unless that imported payload’s handle type was included in VkExternalSemaphoreProperties::exportFromImportedHandleTypes for handleType.
    • If handleType refers to a handle type with copy payload transference semantics, as defined below in Importing Semaphore Payloads, there must be no queue waiting on semaphore.
    • If handleType refers to a handle type with copy payload transference semantics, semaphore must be signaled, or have an associated semaphore signal operation pending execution.
    • handleType must be defined as a POSIX file descriptor handle.
    Valid Usage (Implicit)
    See Also

    GetSemaphoreFdKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • semaphore – the semaphore from which state will be exported.
    • handleType – the type of handle requested.

    Layout

    
     struct VkSemaphoreGetFdInfoKHR {
         VkStructureType sType;
         void const * pNext;
         VkSemaphore semaphore;
         VkExternalSemaphoreHandleTypeFlagBits handleType;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SEMAPHORE, HANDLETYPE

        The struct member offsets.
    • Constructor Detail

      • VkSemaphoreGetFdInfoKHR

        public VkSemaphoreGetFdInfoKHR​(java.nio.ByteBuffer container)
        Creates a VkSemaphoreGetFdInfoKHR 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()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • semaphore

        public long semaphore()
        Returns the value of the semaphore field.
      • handleType

        public int handleType()
        Returns the value of the handleType field.
      • semaphore

        public VkSemaphoreGetFdInfoKHR semaphore​(long value)
        Sets the specified value to the semaphore field.
      • handleType

        public VkSemaphoreGetFdInfoKHR handleType​(int value)
        Sets the specified value to the handleType field.
      • set

        public VkSemaphoreGetFdInfoKHR set​(int sType,
                                           long pNext,
                                           long semaphore,
                                           int handleType)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

        public static VkSemaphoreGetFdInfoKHR mallocStack()
        Returns a new VkSemaphoreGetFdInfoKHR instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkSemaphoreGetFdInfoKHR callocStack()
        Returns a new VkSemaphoreGetFdInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

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

        public static VkSemaphoreGetFdInfoKHR.Buffer callocStack​(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
        Returns a new VkSemaphoreGetFdInfoKHR.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().
      • nsemaphore

        public static long nsemaphore​(long struct)
        Unsafe version of semaphore().
      • nhandleType

        public static int nhandleType​(long struct)
        Unsafe version of handleType().
      • 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.
      • nsemaphore

        public static void nsemaphore​(long struct,
                                      long value)
        Unsafe version of semaphore.
      • nhandleType

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