Class VkTimelineSemaphoreSubmitInfo

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

    public class VkTimelineSemaphoreSubmitInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying signal and wait values for timeline semaphores.
    Description

    If the semaphore in VkSubmitInfo::pWaitSemaphores or VkSubmitInfo::pSignalSemaphores corresponding to an entry in pWaitSemaphoreValues or pSignalSemaphoreValues respectively was not created with a VkSemaphoreType of SEMAPHORE_TYPE_TIMELINE, the implementation must ignore the value in the pWaitSemaphoreValues or pSignalSemaphoreValues entry.

    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO
    • If waitSemaphoreValueCount is not 0, and pWaitSemaphoreValues is not NULL, pWaitSemaphoreValues must be a valid pointer to an array of waitSemaphoreValueCount uint64_t values
    • If signalSemaphoreValueCount is not 0, and pSignalSemaphoreValues is not NULL, pSignalSemaphoreValues must be a valid pointer to an array of signalSemaphoreValueCount uint64_t values

    Layout

    
     struct VkTimelineSemaphoreSubmitInfo {
         VkStructureType sType();
         void const * pNext();
         uint32_t waitSemaphoreValueCount();
         uint64_t const * pWaitSemaphoreValues();
         uint32_t signalSemaphoreValueCount();
         uint64_t const * pSignalSemaphoreValues();
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, WAITSEMAPHOREVALUECOUNT, PWAITSEMAPHOREVALUES, SIGNALSEMAPHOREVALUECOUNT, PSIGNALSEMAPHOREVALUES

        The struct member offsets.
    • Constructor Detail

      • VkTimelineSemaphoreSubmitInfo

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

        public int waitSemaphoreValueCount()
        the number of semaphore wait values specified in pWaitSemaphoreValues.
      • pWaitSemaphoreValues

        @Nullable
        public java.nio.LongBuffer pWaitSemaphoreValues()
        a pointer to an array of waitSemaphoreValueCount values for the corresponding semaphores in VkSubmitInfo::pWaitSemaphores to wait for.
      • signalSemaphoreValueCount

        public int signalSemaphoreValueCount()
        the number of semaphore signal values specified in pSignalSemaphoreValues.
      • pSignalSemaphoreValues

        @Nullable
        public java.nio.LongBuffer pSignalSemaphoreValues()
        a pointer to an array signalSemaphoreValueCount values for the corresponding semaphores in VkSubmitInfo::pSignalSemaphores to set when signaled.
      • set

        public VkTimelineSemaphoreSubmitInfo set​(int sType,
                                                 long pNext,
                                                 int waitSemaphoreValueCount,
                                                 @Nullable
                                                 java.nio.LongBuffer pWaitSemaphoreValues,
                                                 int signalSemaphoreValueCount,
                                                 @Nullable
                                                 java.nio.LongBuffer pSignalSemaphoreValues)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

        public static int nwaitSemaphoreValueCount​(long struct)
        Unsafe version of waitSemaphoreValueCount().
      • npWaitSemaphoreValues

        @Nullable
        public static java.nio.LongBuffer npWaitSemaphoreValues​(long struct)
        Unsafe version of pWaitSemaphoreValues.
      • nsignalSemaphoreValueCount

        public static int nsignalSemaphoreValueCount​(long struct)
        Unsafe version of signalSemaphoreValueCount().
      • npSignalSemaphoreValues

        @Nullable
        public static java.nio.LongBuffer npSignalSemaphoreValues​(long struct)
        Unsafe version of pSignalSemaphoreValues.
      • 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.
      • nwaitSemaphoreValueCount

        public static void nwaitSemaphoreValueCount​(long struct,
                                                    int value)
        Sets the specified value to the waitSemaphoreValueCount field of the specified struct.
      • npWaitSemaphoreValues

        public static void npWaitSemaphoreValues​(long struct,
                                                 @Nullable
                                                 java.nio.LongBuffer value)
        Unsafe version of pWaitSemaphoreValues.
      • nsignalSemaphoreValueCount

        public static void nsignalSemaphoreValueCount​(long struct,
                                                      int value)
        Sets the specified value to the signalSemaphoreValueCount field of the specified struct.
      • npSignalSemaphoreValues

        public static void npSignalSemaphoreValues​(long struct,
                                                   @Nullable
                                                   java.nio.LongBuffer value)
        Unsafe version of pSignalSemaphoreValues.