Package org.lwjgl.vulkan

Class VkSemaphoreSignalInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSemaphoreSignalInfo>
org.lwjgl.vulkan.VkSemaphoreSignalInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkSemaphoreSignalInfoKHR
public class VkSemaphoreSignalInfo extends org.lwjgl.system.Struct<VkSemaphoreSignalInfo> 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 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.

  • Constructor Details

    • VkSemaphoreSignalInfo

      public VkSemaphoreSignalInfo(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 Details

    • sizeof

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

    • 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()
      the handle of the semaphore to signal.

    • value

      public long value()
      the value to signal.

    • sType

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

    • sType$Default

      public VkSemaphoreSignalInfo sType$Default()
      Sets the STRUCTURE_TYPE_SEMAPHORE_SIGNAL_INFO value to the sType() field.

    • pNext

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

    • semaphore

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

    • value

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

    • set

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

    • set

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

    • 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

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

      public static @Nullable VkSemaphoreSignalInfo.Buffer createSafe(long address, int capacity)
      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:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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:
      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().

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