Package org.lwjgl.vulkan
Class VkSubmitInfo2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSubmitInfo2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkSubmitInfo2KHR
public class VkSubmitInfo2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure 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 ofVkPerformanceQuerySubmitInfoKHR,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,QueueSubmit2KHRLayout
struct VkSubmitInfo2 { VkStructureTypesType(); void const *pNext(); VkSubmitFlagsflags(); uint32_twaitSemaphoreInfoCount();VkSemaphoreSubmitInfoconst *pWaitSemaphoreInfos(); uint32_tcommandBufferInfoCount();VkCommandBufferSubmitInfoconst *pCommandBufferInfos(); uint32_tsignalSemaphoreInfoCount();VkSemaphoreSubmitInfoconst *pSignalSemaphoreInfos(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSubmitInfo2.BufferAn array ofVkSubmitInfo2structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCOMMANDBUFFERINFOCOUNT
FLAGS
PCOMMANDBUFFERINFOS
PNEXT
PSIGNALSEMAPHOREINFOS
PWAITSEMAPHOREINFOS
SIGNALSEMAPHOREINFOCOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
WAITSEMAPHOREINFOCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSubmitInfo2(java.nio.ByteBuffer container)Creates aVkSubmitInfo2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static 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.intcommandBufferInfoCount()the 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 VkSubmitInfo2createSafe(long address)static VkSubmitInfo2.BuffercreateSafe(long address, int capacity)intflags()a bitmask ofVkSubmitFlagBits.VkSubmitInfo2flags(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 VkCommandBufferSubmitInfo.BuffernpCommandBufferInfos(long struct)Unsafe version ofpCommandBufferInfos().static voidnpCommandBufferInfos(long struct, VkCommandBufferSubmitInfo.Buffer value)Unsafe version ofpCommandBufferInfos.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkSemaphoreSubmitInfo.BuffernpSignalSemaphoreInfos(long struct)Unsafe version ofpSignalSemaphoreInfos().static voidnpSignalSemaphoreInfos(long struct, VkSemaphoreSubmitInfo.Buffer value)Unsafe version ofpSignalSemaphoreInfos.static VkSemaphoreSubmitInfo.BuffernpWaitSemaphoreInfos(long struct)Unsafe version ofpWaitSemaphoreInfos().static voidnpWaitSemaphoreInfos(long struct, 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.VkCommandBufferSubmitInfo.BufferpCommandBufferInfos()a pointer to an array ofVkCommandBufferSubmitInfostructures describing command buffers to execute in the batch.VkSubmitInfo2pCommandBufferInfos(VkCommandBufferSubmitInfo.Buffer value)Sets the address of the specifiedVkCommandBufferSubmitInfo.Bufferto thepCommandBufferInfos()field.longpNext()NULLor a pointer to a structure extending this structure.VkSubmitInfo2pNext(long value)Sets the specified value to thepNext()field.VkSubmitInfo2pNext(VkPerformanceQuerySubmitInfoKHR value)Prepends the specifiedVkPerformanceQuerySubmitInfoKHRvalue to thepNextchain.VkSubmitInfo2pNext(VkWin32KeyedMutexAcquireReleaseInfoKHR value)Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoKHRvalue to thepNextchain.VkSubmitInfo2pNext(VkWin32KeyedMutexAcquireReleaseInfoNV value)Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoNVvalue to thepNextchain.VkSemaphoreSubmitInfo.BufferpSignalSemaphoreInfos()a pointer to an array ofVkSemaphoreSubmitInfodescribing semaphore signal operations.VkSubmitInfo2pSignalSemaphoreInfos(VkSemaphoreSubmitInfo.Buffer value)Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepSignalSemaphoreInfos()field.VkSemaphoreSubmitInfo.BufferpWaitSemaphoreInfos()a pointer to an array ofVkSemaphoreSubmitInfostructures defining semaphore wait operations.VkSubmitInfo2pWaitSemaphoreInfos(VkSemaphoreSubmitInfo.Buffer value)Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepWaitSemaphoreInfos()field.VkSubmitInfo2set(int sType, long pNext, int flags, VkSemaphoreSubmitInfo.Buffer pWaitSemaphoreInfos, VkCommandBufferSubmitInfo.Buffer pCommandBufferInfos, VkSemaphoreSubmitInfo.Buffer pSignalSemaphoreInfos)Initializes this struct with the specified values.VkSubmitInfo2set(VkSubmitInfo2 src)Copies the specified struct data to this struct.intsignalSemaphoreInfoCount()the number of elements inpSignalSemaphoreInfos.intsizeof()intsType()the type of this structure.VkSubmitInfo2sType(int value)Sets the specified value to thesType()field.VkSubmitInfo2sType$Default()Sets theSTRUCTURE_TYPE_SUBMIT_INFO_2value to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.intwaitSemaphoreInfoCount()the number of elements inpWaitSemaphoreInfos.
-
-
-
Constructor Detail
-
VkSubmitInfo2
public VkSubmitInfo2(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
@Nullable public VkSemaphoreSubmitInfo.Buffer 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
@Nullable public VkCommandBufferSubmitInfo.Buffer 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
@Nullable public VkSemaphoreSubmitInfo.Buffer pSignalSemaphoreInfos()
a pointer to an array ofVkSemaphoreSubmitInfodescribing semaphore signal operations.
-
sType
public VkSubmitInfo2 sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkSubmitInfo2 sType$Default()
Sets theSTRUCTURE_TYPE_SUBMIT_INFO_2value to thesType()field.
-
pNext
public VkSubmitInfo2 pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkSubmitInfo2 pNext(VkPerformanceQuerySubmitInfoKHR value)
Prepends the specifiedVkPerformanceQuerySubmitInfoKHRvalue to thepNextchain.
-
pNext
public VkSubmitInfo2 pNext(VkWin32KeyedMutexAcquireReleaseInfoKHR value)
Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoKHRvalue to thepNextchain.
-
pNext
public VkSubmitInfo2 pNext(VkWin32KeyedMutexAcquireReleaseInfoNV value)
Prepends the specifiedVkWin32KeyedMutexAcquireReleaseInfoNVvalue to thepNextchain.
-
flags
public VkSubmitInfo2 flags(int value)
Sets the specified value to theflags()field.
-
pWaitSemaphoreInfos
public VkSubmitInfo2 pWaitSemaphoreInfos(@Nullable VkSemaphoreSubmitInfo.Buffer value)
Sets the address of the specifiedVkSemaphoreSubmitInfo.Bufferto thepWaitSemaphoreInfos()field.
-
pCommandBufferInfos
public VkSubmitInfo2 pCommandBufferInfos(@Nullable VkCommandBufferSubmitInfo.Buffer value)
Sets the address of the specifiedVkCommandBufferSubmitInfo.Bufferto thepCommandBufferInfos()field.
-
pSignalSemaphoreInfos
public VkSubmitInfo2 pSignalSemaphoreInfos(@Nullable VkSemaphoreSubmitInfo.Buffer value)
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
public VkSubmitInfo2 set(VkSubmitInfo2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSubmitInfo2 malloc()
Returns a newVkSubmitInfo2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSubmitInfo2 calloc()
Returns a newVkSubmitInfo2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSubmitInfo2 create()
Returns a newVkSubmitInfo2instance allocated withBufferUtils.
-
create
public static VkSubmitInfo2 create(long address)
Returns a newVkSubmitInfo2instance for the specified memory address.
-
createSafe
@Nullable public static VkSubmitInfo2 createSafe(long address)
-
malloc
public static VkSubmitInfo2.Buffer malloc(int capacity)
Returns a newVkSubmitInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSubmitInfo2.Buffer calloc(int capacity)
Returns a newVkSubmitInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubmitInfo2.Buffer create(int capacity)
Returns a newVkSubmitInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubmitInfo2.Buffer create(long address, int capacity)
Create aVkSubmitInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSubmitInfo2.Buffer createSafe(long address, int capacity)
-
malloc
public static VkSubmitInfo2 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkSubmitInfo2 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubmitInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSubmitInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkSubmitInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubmitInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static VkSemaphoreSubmitInfo.Buffer npWaitSemaphoreInfos(long struct)
Unsafe version ofpWaitSemaphoreInfos().
-
ncommandBufferInfoCount
public static int ncommandBufferInfoCount(long struct)
Unsafe version ofcommandBufferInfoCount().
-
npCommandBufferInfos
@Nullable public static VkCommandBufferSubmitInfo.Buffer npCommandBufferInfos(long struct)
Unsafe version ofpCommandBufferInfos().
-
nsignalSemaphoreInfoCount
public static int nsignalSemaphoreInfoCount(long struct)
Unsafe version ofsignalSemaphoreInfoCount().
-
npSignalSemaphoreInfos
@Nullable public static VkSemaphoreSubmitInfo.Buffer npSignalSemaphoreInfos(long struct)
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
public static void npWaitSemaphoreInfos(long struct, @Nullable VkSemaphoreSubmitInfo.Buffer value)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
-
-