Package org.lwjgl.vulkan

Class VkSemaphoreWaitInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSemaphoreWaitInfo>
org.lwjgl.vulkan.VkSemaphoreWaitInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkSemaphoreWaitInfoKHR
public class VkSemaphoreWaitInfo extends org.lwjgl.system.Struct<VkSemaphoreWaitInfo> implements org.lwjgl.system.NativeResource
Structure containing information about the semaphore wait condition.
Valid Usage
  • All of the elements of pSemaphores must reference a semaphore that was created with a VkSemaphoreType of SEMAPHORE_TYPE_TIMELINE
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO
  • pNext must be NULL
  • flags must be a valid combination of VkSemaphoreWaitFlagBits values
  • pSemaphores must be a valid pointer to an array of semaphoreCount valid VkSemaphore handles
  • pValues must be a valid pointer to an array of semaphoreCount uint64_t values
  • semaphoreCount must be greater than 0
See Also

WaitSemaphores, WaitSemaphoresKHR

Layout


 struct VkSemaphoreWaitInfo {
     VkStructureType sType();
     void const * pNext();
     VkSemaphoreWaitFlags flags();
     uint32_t semaphoreCount();
     VkSemaphore const * pSemaphores();
     uint64_t const * pValues();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • SEMAPHORECOUNT

      public static final int SEMAPHORECOUNT
      The struct member offsets.

    • PSEMAPHORES

      public static final int PSEMAPHORES
      The struct member offsets.

    • PVALUES

      public static final int PVALUES
      The struct member offsets.

  • Constructor Details

    • VkSemaphoreWaitInfo

      public VkSemaphoreWaitInfo(ByteBuffer container)
      Creates a VkSemaphoreWaitInfo 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 Details

    • sizeof

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

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

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

    • flags

      public int flags()
      a bitmask of VkSemaphoreWaitFlagBits specifying additional parameters for the semaphore wait operation.

    • semaphoreCount

      public int semaphoreCount()
      the number of semaphores to wait on.

    • pSemaphores

      public LongBuffer pSemaphores()
      a pointer to an array of semaphoreCount semaphore handles to wait on.

    • pValues

      public LongBuffer pValues()
      a pointer to an array of semaphoreCount timeline semaphore values.

    • sType

      public VkSemaphoreWaitInfo sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkSemaphoreWaitInfo sType$Default()
      Sets the STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO value to the sType() field.

    • pNext

      public VkSemaphoreWaitInfo pNext(long value)
      Sets the specified value to the pNext() field.

    • flags

      public VkSemaphoreWaitInfo flags(int value)
      Sets the specified value to the flags() field.

    • semaphoreCount

      public VkSemaphoreWaitInfo semaphoreCount(int value)
      Sets the specified value to the semaphoreCount() field.

    • pSemaphores

      public VkSemaphoreWaitInfo pSemaphores(LongBuffer value)
      Sets the address of the specified LongBuffer to the pSemaphores() field.

    • pValues

      public VkSemaphoreWaitInfo pValues(LongBuffer value)
      Sets the address of the specified LongBuffer to the pValues() field.

    • set

      public VkSemaphoreWaitInfo set(int sType, long pNext, int flags, int semaphoreCount, LongBuffer pSemaphores, LongBuffer pValues)
      Initializes this struct with the specified values.

    • set

      public VkSemaphoreWaitInfo set(VkSemaphoreWaitInfo src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

      public static VkSemaphoreWaitInfo.Buffer malloc(int capacity)
      Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkSemaphoreWaitInfo.Buffer calloc(int capacity)
      Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSemaphoreWaitInfo.Buffer create(int capacity)
      Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSemaphoreWaitInfo.Buffer create(long address, int capacity)
      Create a VkSemaphoreWaitInfo.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkSemaphoreWaitInfo.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static VkSemaphoreWaitInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkSemaphoreWaitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      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().

    • nflags

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

    • nsemaphoreCount

      public static int nsemaphoreCount(long struct)
      Unsafe version of semaphoreCount().

    • npSemaphores

      public static LongBuffer npSemaphores(long struct)
      Unsafe version of pSemaphores.

    • npValues

      public static LongBuffer npValues(long struct)
      Unsafe version of pValues.

    • 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.

    • nflags

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

    • nsemaphoreCount

      public static void nsemaphoreCount(long struct, int value)
      Sets the specified value to the semaphoreCount field of the specified struct.

    • npSemaphores

      public static void npSemaphores(long struct, LongBuffer value)
      Unsafe version of pSemaphores.

    • npValues

      public static void npValues(long struct, LongBuffer value)
      Unsafe version of pValues.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate