Package org.lwjgl.vulkan

Class VkSemaphoreTypeCreateInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSemaphoreTypeCreateInfo>
org.lwjgl.vulkan.VkSemaphoreTypeCreateInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkSemaphoreTypeCreateInfoKHR
public class VkSemaphoreTypeCreateInfo extends org.lwjgl.system.Struct<VkSemaphoreTypeCreateInfo> implements org.lwjgl.system.NativeResource
Structure specifying the type of a newly created semaphore.
Description

To create a semaphore of a specific type, add a VkSemaphoreTypeCreateInfo structure to the VkSemaphoreCreateInfo::pNext chain.

If no VkSemaphoreTypeCreateInfo structure is included in the pNext chain of VkSemaphoreCreateInfo, then the created semaphore will have a default VkSemaphoreType of SEMAPHORE_TYPE_BINARY.

Valid Usage
Valid Usage (Implicit)

Layout


 struct VkSemaphoreTypeCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkSemaphoreType semaphoreType();
     uint64_t initialValue();
 }

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

    • SEMAPHORETYPE

      public static final int SEMAPHORETYPE
      The struct member offsets.

    • INITIALVALUE

      public static final int INITIALVALUE
      The struct member offsets.

  • Constructor Details

    • VkSemaphoreTypeCreateInfo

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

    • sType

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

    • pNext

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

    • semaphoreType

      public int semaphoreType()
      a VkSemaphoreType value specifying the type of the semaphore.

    • initialValue

      public long initialValue()
      the initial payload value if semaphoreType is SEMAPHORE_TYPE_TIMELINE.

    • sType

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

    • sType$Default

      public VkSemaphoreTypeCreateInfo sType$Default()
      Sets the STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO value to the sType() field.

    • pNext

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

    • semaphoreType

      public VkSemaphoreTypeCreateInfo semaphoreType(int value)
      Sets the specified value to the semaphoreType() field.

    • initialValue

      public VkSemaphoreTypeCreateInfo initialValue(long value)
      Sets the specified value to the initialValue() field.

    • set

      public VkSemaphoreTypeCreateInfo set(int sType, long pNext, int semaphoreType, long initialValue)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nsemaphoreType

      public static int nsemaphoreType(long struct)
      Unsafe version of semaphoreType().

    • ninitialValue

      public static long ninitialValue(long struct)
      Unsafe version of initialValue().

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

    • nsemaphoreType

      public static void nsemaphoreType(long struct, int value)
      Unsafe version of semaphoreType.

    • ninitialValue

      public static void ninitialValue(long struct, long value)
      Unsafe version of initialValue.