Class VkSemaphoreSignalInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkSemaphoreSignalInfoKHR

    public class VkSemaphoreSignalInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure containing information about a semaphore signal operation.
    Valid Usage
    • semaphore must have been created with a VkSemaphoreType of SEMAPHORE_TYPE_TIMELINE
    • value must have a value greater than the current value of the semaphore
    • value must be less than the value of any pending semaphore signal operations
    • value must have a value which does not differ from the current value of the semaphore or the value of any outstanding semaphore wait or signal operation on semaphore by more than maxTimelineSemaphoreValueDifference
    Valid Usage (Implicit)
    See Also

    SignalSemaphore, SignalSemaphoreKHR

    Layout

    
     struct VkSemaphoreSignalInfo {
         VkStructureType sType();
         void const * pNext();
         VkSemaphore semaphore();
         uint64_t value();
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

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

        The struct member offsets.
    • Constructor Detail

      • VkSemaphoreSignalInfo

        public VkSemaphoreSignalInfo​(java.nio.ByteBuffer container)
        Creates a VkSemaphoreSignalInfo 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.
      • semaphore

        public long semaphore()
        the handle of the semaphore to signal.
      • value

        public long value()
        the value to signal.
      • set

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

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

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

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

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

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

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

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

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

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

        public static long nvalue​(long struct)
        Unsafe version of value().
      • 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.
      • nvalue

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