Package org.lwjgl.vulkan

Class VkSemaphoreSubmitInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSemaphoreSubmitInfo>
org.lwjgl.vulkan.VkSemaphoreSubmitInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkSemaphoreSubmitInfoKHR
public class VkSemaphoreSubmitInfo extends org.lwjgl.system.Struct<VkSemaphoreSubmitInfo> implements org.lwjgl.system.NativeResource
Structure specifying a semaphore signal or wait operation.
Description

Whether this structure defines a semaphore wait or signal operation is defined by how it is used.

Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO
  • pNext must be NULL
  • semaphore must be a valid VkSemaphore handle
  • stageMask must be a valid combination of VkPipelineStageFlagBits2 values
See Also

VkRenderPassStripeSubmitInfoARM, VkSubmitInfo2

Layout


 struct VkSemaphoreSubmitInfo {
     VkStructureType sType();
     void const * pNext();
     VkSemaphore semaphore();
     uint64_t value();
     VkPipelineStageFlags2 stageMask();
     uint32_t deviceIndex();
 }

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

    • SEMAPHORE

      public static final int SEMAPHORE
      The struct member offsets.

    • VALUE

      public static final int VALUE
      The struct member offsets.

    • STAGEMASK

      public static final int STAGEMASK
      The struct member offsets.

    • DEVICEINDEX

      public static final int DEVICEINDEX
      The struct member offsets.

  • Constructor Details

    • VkSemaphoreSubmitInfo

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

    • sType

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

    • pNext

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

    • semaphore

      public long semaphore()
      a VkSemaphore affected by this operation.

    • value

      public long value()
      either the value used to signal semaphore or the value waited on by semaphore, if semaphore is a timeline semaphore. Otherwise it is ignored.

    • stageMask

      public long stageMask()
      a VkPipelineStageFlags2 mask of pipeline stages which limit the first synchronization scope of a semaphore signal operation, or second synchronization scope of a semaphore wait operation as described in the semaphore wait operation and semaphore signal operation sections of the synchronization chapter.

    • deviceIndex

      public int deviceIndex()
      the index of the device within a device group that executes the semaphore wait or signal operation.

    • sType

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

    • sType$Default

      public VkSemaphoreSubmitInfo sType$Default()
      Sets the STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO value to the sType() field.

    • pNext

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

    • semaphore

      public VkSemaphoreSubmitInfo semaphore(long value)
      Sets the specified value to the semaphore() field.

    • value

      public VkSemaphoreSubmitInfo value(long value)
      Sets the specified value to the value() field.

    • stageMask

      public VkSemaphoreSubmitInfo stageMask(long value)
      Sets the specified value to the stageMask() field.

    • deviceIndex

      public VkSemaphoreSubmitInfo deviceIndex(int value)
      Sets the specified value to the deviceIndex() field.

    • set

      public VkSemaphoreSubmitInfo set(int sType, long pNext, long semaphore, long value, long stageMask, int deviceIndex)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nsemaphore

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

    • nvalue

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

    • nstageMask

      public static long nstageMask(long struct)
      Unsafe version of stageMask().

    • ndeviceIndex

      public static int ndeviceIndex(long struct)
      Unsafe version of deviceIndex().

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

    • nstageMask

      public static void nstageMask(long struct, long value)
      Unsafe version of stageMask.

    • ndeviceIndex

      public static void ndeviceIndex(long struct, int value)
      Unsafe version of deviceIndex.