Package org.lwjgl.vulkan
Class VkSubmitInfo2
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSubmitInfo2>
org.lwjgl.vulkan.VkSubmitInfo2
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkSubmitInfo2KHR
public class VkSubmitInfo2
extends org.lwjgl.system.Struct<VkSubmitInfo2>
implements org.lwjgl.system.NativeResource
Structure specifying a queue submit operation.
Valid Usage
- If the same semaphore is used as the
semaphoremember of both an element ofpSignalSemaphoreInfosandpWaitSemaphoreInfos, and that semaphore is a timeline semaphore, thevaluemember of thepSignalSemaphoreInfoselement must be greater than thevaluemember of thepWaitSemaphoreInfoselement - If the
semaphoremember of any element ofpSignalSemaphoreInfosis a timeline semaphore, thevaluemember of that element must have a value greater than the current value of the semaphore when the semaphore signal operation is executed - If the
semaphoremember of any element ofpSignalSemaphoreInfosis a timeline semaphore, thevaluemember of that element 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 that semaphore by more thanmaxTimelineSemaphoreValueDifference - If the
semaphoremember of any element ofpWaitSemaphoreInfosis a timeline semaphore, thevaluemember of that element 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 that semaphore by more thanmaxTimelineSemaphoreValueDifference - If
flagsincludesSUBMIT_PROTECTED_BIT, all elements ofpCommandBuffersmust be protected command buffers - If
flagsdoes not includeSUBMIT_PROTECTED_BIT, each element ofpCommandBuffersmust not be a protected command buffer - If any
commandBuffermember of an element ofpCommandBufferInfoscontains any resumed render pass instances, they must be suspended by a render pass instance earlier in submission order withinpCommandBufferInfos - If any
commandBuffermember of an element ofpCommandBufferInfoscontains any suspended render pass instances, they must be resumed by a render pass instance later in submission order withinpCommandBufferInfos - If any
commandBuffermember of an element ofpCommandBufferInfoscontains any suspended render pass instances, there must be no action or synchronization commands between that render pass instance and the render pass instance that resumes it - If any
commandBuffermember of an element ofpCommandBufferInfoscontains any suspended render pass instances, there must be no render pass instances between that render pass instance and the render pass instance that resumes it - If the
variableSampleLocationslimit is not supported, and anycommandBuffermember of an element ofpCommandBufferInfoscontains any suspended render pass instances, where a graphics pipeline has been bound, any pipelines bound in the render pass instance that resumes it, or any subsequent render pass instances that resume from that one and so on, must use the same sample locations
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SUBMIT_INFO_2- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkFrameBoundaryEXT,VkLatencySubmissionPresentIdNV,VkPerformanceQuerySubmitInfoKHR,VkWin32KeyedMutexAcquireReleaseInfoKHR, orVkWin32KeyedMutexAcquireReleaseInfoNV - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be a valid combination ofVkSubmitFlagBitsvalues- If
waitSemaphoreInfoCountis not 0,pWaitSemaphoreInfosmust be a valid pointer to an array ofwaitSemaphoreInfoCountvalidVkSemaphoreSubmitInfostructures - If
commandBufferInfoCountis not 0,pCommandBufferInfosmust be a valid pointer to an array ofcommandBufferInfoCountvalidVkCommandBufferSubmitInfostructures - If
signalSemaphoreInfoCountis not 0,pSignalSemaphoreInfosmust be a valid pointer to an array ofsignalSemaphoreInfoCountvalidVkSemaphoreSubmitInfostructures
See Also
VkCommandBufferSubmitInfo, VkSemaphoreSubmitInfo, QueueSubmit2, QueueSubmit2KHR
Layout
struct VkSubmitInfo2 {
VkStructureType sType();
void const * pNext();
VkSubmitFlags flags();
uint32_t waitSemaphoreInfoCount();
VkSemaphoreSubmitInfo const * pWaitSemaphoreInfos();
uint32_t commandBufferInfoCount();
VkCommandBufferSubmitInfo const * pCommandBufferInfos();
uint32_t signalSemaphoreInfoCount();
VkSemaphoreSubmitInfo const * pSignalSemaphoreInfos();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSubmitInfo2(ByteBuffer container) Creates aVkSubmitInfo2instance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSubmitInfo2calloc()Returns a newVkSubmitInfo2instance allocated withmemCalloc.static VkSubmitInfo2.Buffercalloc(int capacity) Returns a newVkSubmitInfo2.Bufferinstance allocated withmemCalloc.static VkSubmitInfo2.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSubmitInfo2calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe number of elements inpCommandBufferInfosand the number of command buffers to execute in the batch.static VkSubmitInfo2create()Returns a newVkSubmitInfo2instance allocated withBufferUtils.static VkSubmitInfo2.Buffercreate(int capacity) Returns a newVkSubmitInfo2.Bufferinstance allocated withBufferUtils.static VkSubmitInfo2create(long address) Returns a newVkSubmitInfo2instance for the specified memory address.static VkSubmitInfo2.Buffercreate(long address, int capacity) Create aVkSubmitInfo2.Bufferinstance at the specified memory.static @Nullable VkSubmitInfo2createSafe(long address) static @Nullable VkSubmitInfo2.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkSubmitFlagBits.flags(int value) Sets the specified value to theflags()field.static VkSubmitInfo2malloc()Returns a newVkSubmitInfo2instance allocated withmemAlloc.static VkSubmitInfo2.Buffermalloc(int capacity) Returns a newVkSubmitInfo2.Bufferinstance allocated withmemAlloc.static VkSubmitInfo2.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStack.static VkSubmitInfo2malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStack.static intncommandBufferInfoCount(long struct) Unsafe version ofcommandBufferInfoCount().static voidncommandBufferInfoCount(long struct, int value) Sets the specified value to thecommandBufferInfoCountfield of the specifiedstruct.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static @Nullable VkCommandBufferSubmitInfo.BuffernpCommandBufferInfos(long struct) Unsafe version ofpCommandBufferInfos().static voidnpCommandBufferInfos(long struct, @Nullable VkCommandBufferSubmitInfo.Buffer value) Unsafe version ofpCommandBufferInfos.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkSemaphoreSubmitInfo.BuffernpSignalSemaphoreInfos(long struct) Unsafe version ofpSignalSemaphoreInfos().static voidnpSignalSemaphoreInfos(long struct, @Nullable VkSemaphoreSubmitInfo.Buffer value) Unsafe version ofpSignalSemaphoreInfos.static @Nullable VkSemaphoreSubmitInfo.BuffernpWaitSemaphoreInfos(long struct) Unsafe version ofpWaitSemaphoreInfos().static voidnpWaitSemaphoreInfos(long struct, @Nullable VkSemaphoreSubmitInfo.Buffer value) Unsafe version ofpWaitSemaphoreInfos.static intnsignalSemaphoreInfoCount(long struct) Unsafe version ofsignalSemaphoreInfoCount().static voidnsignalSemaphoreInfoCount(long struct, int value) Sets the specified value to thesignalSemaphoreInfoCountfield of the specifiedstruct.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnwaitSemaphoreInfoCount(long struct) Unsafe version ofwaitSemaphoreInfoCount().static voidnwaitSemaphoreInfoCount(long struct, int value) Sets the specified value to thewaitSemaphoreInfoCountfield of the specifiedstruct.@Nullable VkCommandBufferSubmitInfo.Buffera pointer to an array ofVkCommandBufferSubmitInfostructures describing command buffers to execute in the batch.pCommandBufferInfos(@Nullable VkCommandBufferSubmitInfo.Buffer value) Sets the address of the specifiedVkCommandBufferSubmitInfo.Bufferto thepCommandBufferInfos()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.pNext(VkFrameBoundaryEXT value) Prepends the specifiedVkFrameBoundaryEXTvalue to thepNextchain.Prepends the specifiedVkLatencySubmissionPresentIdNVvalue to thepNextchain.Prepends the specifiedVkPerformanceQuerySubmitInfoKHRvalue to thepNextchain.Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoKHRvalue to thepNextchain.Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoNVvalue to thepNextchain.@Nullable VkSemaphoreSubmitInfo.Buffera pointer to an array ofVkSemaphoreSubmitInfodescribing semaphore signal operations.pSignalSemaphoreInfos(@Nullable VkSemaphoreSubmitInfo.Buffer value) Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepSignalSemaphoreInfos()field.@Nullable VkSemaphoreSubmitInfo.Buffera pointer to an array ofVkSemaphoreSubmitInfostructures defining semaphore wait operations.pWaitSemaphoreInfos(@Nullable VkSemaphoreSubmitInfo.Buffer value) Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepWaitSemaphoreInfos()field.set(int sType, long pNext, int flags, @Nullable VkSemaphoreSubmitInfo.Buffer pWaitSemaphoreInfos, @Nullable VkCommandBufferSubmitInfo.Buffer pCommandBufferInfos, @Nullable VkSemaphoreSubmitInfo.Buffer pSignalSemaphoreInfos) Initializes this struct with the specified values.set(VkSubmitInfo2 src) Copies the specified struct data to this struct.intthe number of elements inpSignalSemaphoreInfos.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SUBMIT_INFO_2value to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.intthe number of elements inpWaitSemaphoreInfos.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
WAITSEMAPHOREINFOCOUNT
public static final int WAITSEMAPHOREINFOCOUNTThe struct member offsets. -
PWAITSEMAPHOREINFOS
public static final int PWAITSEMAPHOREINFOSThe struct member offsets. -
COMMANDBUFFERINFOCOUNT
public static final int COMMANDBUFFERINFOCOUNTThe struct member offsets. -
PCOMMANDBUFFERINFOS
public static final int PCOMMANDBUFFERINFOSThe struct member offsets. -
SIGNALSEMAPHOREINFOCOUNT
public static final int SIGNALSEMAPHOREINFOCOUNTThe struct member offsets. -
PSIGNALSEMAPHOREINFOS
public static final int PSIGNALSEMAPHOREINFOSThe struct member offsets.
-
-
Constructor Details
-
VkSubmitInfo2
Creates aVkSubmitInfo2instance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkSubmitInfo2>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkSubmitFlagBits. -
waitSemaphoreInfoCount
public int waitSemaphoreInfoCount()the number of elements inpWaitSemaphoreInfos. -
pWaitSemaphoreInfos
a pointer to an array ofVkSemaphoreSubmitInfostructures defining semaphore wait operations. -
commandBufferInfoCount
public int commandBufferInfoCount()the number of elements inpCommandBufferInfosand the number of command buffers to execute in the batch. -
pCommandBufferInfos
a pointer to an array ofVkCommandBufferSubmitInfostructures describing command buffers to execute in the batch. -
signalSemaphoreInfoCount
public int signalSemaphoreInfoCount()the number of elements inpSignalSemaphoreInfos. -
pSignalSemaphoreInfos
a pointer to an array ofVkSemaphoreSubmitInfodescribing semaphore signal operations. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SUBMIT_INFO_2value to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkFrameBoundaryEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkLatencySubmissionPresentIdNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkPerformanceQuerySubmitInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoNVvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
pWaitSemaphoreInfos
Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepWaitSemaphoreInfos()field. -
pCommandBufferInfos
Sets the address of the specifiedVkCommandBufferSubmitInfo.Bufferto thepCommandBufferInfos()field. -
pSignalSemaphoreInfos
Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepSignalSemaphoreInfos()field. -
set
public VkSubmitInfo2 set(int sType, long pNext, int flags, @Nullable VkSemaphoreSubmitInfo.Buffer pWaitSemaphoreInfos, @Nullable VkCommandBufferSubmitInfo.Buffer pCommandBufferInfos, @Nullable VkSemaphoreSubmitInfo.Buffer pSignalSemaphoreInfos) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSubmitInfo2instance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSubmitInfo2instance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSubmitInfo2instance allocated withBufferUtils. -
create
Returns a newVkSubmitInfo2instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSubmitInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSubmitInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSubmitInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSubmitInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nwaitSemaphoreInfoCount
public static int nwaitSemaphoreInfoCount(long struct) Unsafe version ofwaitSemaphoreInfoCount(). -
npWaitSemaphoreInfos
Unsafe version ofpWaitSemaphoreInfos(). -
ncommandBufferInfoCount
public static int ncommandBufferInfoCount(long struct) Unsafe version ofcommandBufferInfoCount(). -
npCommandBufferInfos
Unsafe version ofpCommandBufferInfos(). -
nsignalSemaphoreInfoCount
public static int nsignalSemaphoreInfoCount(long struct) Unsafe version ofsignalSemaphoreInfoCount(). -
npSignalSemaphoreInfos
Unsafe version ofpSignalSemaphoreInfos(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nwaitSemaphoreInfoCount
public static void nwaitSemaphoreInfoCount(long struct, int value) Sets the specified value to thewaitSemaphoreInfoCountfield of the specifiedstruct. -
npWaitSemaphoreInfos
Unsafe version ofpWaitSemaphoreInfos. -
ncommandBufferInfoCount
public static void ncommandBufferInfoCount(long struct, int value) Sets the specified value to thecommandBufferInfoCountfield of the specifiedstruct. -
npCommandBufferInfos
public static void npCommandBufferInfos(long struct, @Nullable VkCommandBufferSubmitInfo.Buffer value) Unsafe version ofpCommandBufferInfos. -
nsignalSemaphoreInfoCount
public static void nsignalSemaphoreInfoCount(long struct, int value) Sets the specified value to thesignalSemaphoreInfoCountfield of the specifiedstruct. -
npSignalSemaphoreInfos
public static void npSignalSemaphoreInfos(long struct, @Nullable VkSemaphoreSubmitInfo.Buffer value) Unsafe version ofpSignalSemaphoreInfos. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-