Package org.lwjgl.vulkan

Class VkTimelineSemaphoreSubmitInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkTimelineSemaphoreSubmitInfo>

org.lwjgl.vulkan.VkTimelineSemaphoreSubmitInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkTimelineSemaphoreSubmitInfoKHR

public class VkTimelineSemaphoreSubmitInfo
extends org.lwjgl.system.Struct<VkTimelineSemaphoreSubmitInfo>
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();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkTimelineSemaphoreSubmitInfo.Buffer	An array of VkTimelineSemaphoreSubmitInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PSIGNALSEMAPHOREVALUES	The struct member offsets.
static final int	PWAITSEMAPHOREVALUES	The struct member offsets.
static final int	SIGNALSEMAPHOREVALUECOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	WAITSEMAPHOREVALUECOUNT	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkTimelineSemaphoreSubmitInfo(ByteBuffer container)	Creates a VkTimelineSemaphoreSubmitInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkTimelineSemaphoreSubmitInfo	calloc()	Returns a new VkTimelineSemaphoreSubmitInfo instance allocated with memCalloc.
static VkTimelineSemaphoreSubmitInfo.Buffer	calloc(int capacity)	Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with memCalloc.
static VkTimelineSemaphoreSubmitInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
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.
static VkTimelineSemaphoreSubmitInfo	create()	Returns a new VkTimelineSemaphoreSubmitInfo instance allocated with BufferUtils.
static VkTimelineSemaphoreSubmitInfo.Buffer	create(int capacity)	Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with BufferUtils.
static VkTimelineSemaphoreSubmitInfo	create(long address)	Returns a new VkTimelineSemaphoreSubmitInfo instance for the specified memory address.
static VkTimelineSemaphoreSubmitInfo.Buffer	create(long address, int capacity)	Create a VkTimelineSemaphoreSubmitInfo.Buffer instance at the specified memory.
static @Nullable VkTimelineSemaphoreSubmitInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkTimelineSemaphoreSubmitInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkTimelineSemaphoreSubmitInfo	malloc()	Returns a new VkTimelineSemaphoreSubmitInfo instance allocated with memAlloc.
static VkTimelineSemaphoreSubmitInfo.Buffer	malloc(int capacity)	Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with memAlloc.
static VkTimelineSemaphoreSubmitInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated on the specified MemoryStack.
static VkTimelineSemaphoreSubmitInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkTimelineSemaphoreSubmitInfo instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable LongBuffer	npSignalSemaphoreValues(long struct)	Unsafe version of pSignalSemaphoreValues.
static void	npSignalSemaphoreValues(long struct, @Nullable LongBuffer value)	Unsafe version of pSignalSemaphoreValues.
static @Nullable LongBuffer	npWaitSemaphoreValues(long struct)	Unsafe version of pWaitSemaphoreValues.
static void	npWaitSemaphoreValues(long struct, @Nullable LongBuffer value)	Unsafe version of pWaitSemaphoreValues.
static int	nsignalSemaphoreValueCount(long struct)	Unsafe version of signalSemaphoreValueCount().
static void	nsignalSemaphoreValueCount(long struct, int value)	Sets the specified value to the signalSemaphoreValueCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nwaitSemaphoreValueCount(long struct)	Unsafe version of waitSemaphoreValueCount().
static void	nwaitSemaphoreValueCount(long struct, int value)	Sets the specified value to the waitSemaphoreValueCount field of the specified struct.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkTimelineSemaphoreSubmitInfo	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable LongBuffer	pSignalSemaphoreValues()	a pointer to an array signalSemaphoreValueCount values for the corresponding semaphores in VkSubmitInfo::pSignalSemaphores to set when signaled.
VkTimelineSemaphoreSubmitInfo	pSignalSemaphoreValues(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pSignalSemaphoreValues() field.
@Nullable LongBuffer	pWaitSemaphoreValues()	a pointer to an array of waitSemaphoreValueCount values for the corresponding semaphores in VkSubmitInfo::pWaitSemaphores to wait for.
VkTimelineSemaphoreSubmitInfo	pWaitSemaphoreValues(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pWaitSemaphoreValues() field.
VkTimelineSemaphoreSubmitInfo	set(int sType, long pNext, int waitSemaphoreValueCount, @Nullable LongBuffer pWaitSemaphoreValues, int signalSemaphoreValueCount, @Nullable LongBuffer pSignalSemaphoreValues)	Initializes this struct with the specified values.
VkTimelineSemaphoreSubmitInfo	set(VkTimelineSemaphoreSubmitInfo src)	Copies the specified struct data to this struct.
int	signalSemaphoreValueCount()	the number of semaphore signal values specified in pSignalSemaphoreValues.
VkTimelineSemaphoreSubmitInfo	signalSemaphoreValueCount(int value)	Sets the specified value to the signalSemaphoreValueCount() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkTimelineSemaphoreSubmitInfo	sType(int value)	Sets the specified value to the sType() field.
VkTimelineSemaphoreSubmitInfo	sType$Default()	Sets the STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO value to the sType() field.
int	waitSemaphoreValueCount()	the number of semaphore wait values specified in pWaitSemaphoreValues.
VkTimelineSemaphoreSubmitInfo	waitSemaphoreValueCount(int value)	Sets the specified value to the waitSemaphoreValueCount() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

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.

WAITSEMAPHOREVALUECOUNT

public static final int WAITSEMAPHOREVALUECOUNT

The struct member offsets.

PWAITSEMAPHOREVALUES

public static final int PWAITSEMAPHOREVALUES

The struct member offsets.

SIGNALSEMAPHOREVALUECOUNT

public static final int SIGNALSEMAPHOREVALUECOUNT

The struct member offsets.

PSIGNALSEMAPHOREVALUES

public static final int PSIGNALSEMAPHOREVALUES

The struct member offsets.

Constructor Details

VkTimelineSemaphoreSubmitInfo

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkTimelineSemaphoreSubmitInfo>

sType

public int sType()

a VkStructureType value identifying 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

public @Nullable 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

public @Nullable LongBuffer pSignalSemaphoreValues()

a pointer to an array signalSemaphoreValueCount values for the corresponding semaphores in VkSubmitInfo::pSignalSemaphores to set when signaled.

sType

public VkTimelineSemaphoreSubmitInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkTimelineSemaphoreSubmitInfo sType$Default()

Sets the STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO value to the sType() field.

pNext

public VkTimelineSemaphoreSubmitInfo pNext(long value)

Sets the specified value to the pNext() field.

waitSemaphoreValueCount

public VkTimelineSemaphoreSubmitInfo waitSemaphoreValueCount(int value)

Sets the specified value to the waitSemaphoreValueCount() field.

pWaitSemaphoreValues

public VkTimelineSemaphoreSubmitInfo pWaitSemaphoreValues(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pWaitSemaphoreValues() field.

signalSemaphoreValueCount

public VkTimelineSemaphoreSubmitInfo signalSemaphoreValueCount(int value)

Sets the specified value to the signalSemaphoreValueCount() field.

pSignalSemaphoreValues

public VkTimelineSemaphoreSubmitInfo pSignalSemaphoreValues(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pSignalSemaphoreValues() field.

set

public VkTimelineSemaphoreSubmitInfo set(int sType,
 long pNext,
 int waitSemaphoreValueCount,
 @Nullable LongBuffer pWaitSemaphoreValues,
 int signalSemaphoreValueCount,
 @Nullable LongBuffer pSignalSemaphoreValues)

Initializes this struct with the specified values.

set

public VkTimelineSemaphoreSubmitInfo set(VkTimelineSemaphoreSubmitInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

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()

Returns a new VkTimelineSemaphoreSubmitInfo instance allocated with BufferUtils.

create

public static VkTimelineSemaphoreSubmitInfo create(long address)

Returns a new VkTimelineSemaphoreSubmitInfo instance for the specified memory address.

createSafe

public static @Nullable VkTimelineSemaphoreSubmitInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkTimelineSemaphoreSubmitInfo.Buffer malloc(int capacity)

Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkTimelineSemaphoreSubmitInfo.Buffer calloc(int capacity)

Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkTimelineSemaphoreSubmitInfo.Buffer create(int capacity)

Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkTimelineSemaphoreSubmitInfo.Buffer create(long address,
 int capacity)

Create a VkTimelineSemaphoreSubmitInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkTimelineSemaphoreSubmitInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

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

malloc

public static VkTimelineSemaphoreSubmitInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkTimelineSemaphoreSubmitInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkTimelineSemaphoreSubmitInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkTimelineSemaphoreSubmitInfo.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().

nwaitSemaphoreValueCount

public static int nwaitSemaphoreValueCount(long struct)

Unsafe version of waitSemaphoreValueCount().

npWaitSemaphoreValues

public static @Nullable LongBuffer npWaitSemaphoreValues(long struct)

Unsafe version of pWaitSemaphoreValues.

nsignalSemaphoreValueCount

public static int nsignalSemaphoreValueCount(long struct)

Unsafe version of signalSemaphoreValueCount().

npSignalSemaphoreValues

public static @Nullable 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 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 LongBuffer value)

Unsafe version of pSignalSemaphoreValues.