public class VkSubmitInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
The order that command buffers appear in pCommandBuffers is used to determine submission order, and thus all the implicit ordering guarantees that respect it. Other than these implicit ordering guarantees and any explicit synchronization primitives, these command buffers may overlap or otherwise execute out of order.
pCommandBuffers must not have been allocated with COMMAND_BUFFER_LEVEL_SECONDARYpWaitDstStageMask must not contain PIPELINE_STAGE_GEOMETRY_SHADER_BITpWaitDstStageMask must not contain PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BITpWaitDstStageMask must not include PIPELINE_STAGE_HOST_BIT.pWaitSemaphores or pSignalSemaphores was created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR, then the pNext chain must include a VkTimelineSemaphoreSubmitInfoKHR structurepNext chain of this structure includes a VkTimelineSemaphoreSubmitInfoKHR structure and any element of pWaitSemaphores was created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR, then its waitSemaphoreValueCount member must equal waitSemaphoreCountpNext chain of this structure includes a VkTimelineSemaphoreSubmitInfoKHR structure and any element of pSignalSemaphores was created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR, then its signalSemaphoreValueCount member must equal signalSemaphoreCountpSignalSemaphores created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR the corresponding element of VkTimelineSemaphoreSubmitInfoKHR::pSignalSemaphoreValues must have a value greater than the current value of the semaphore when the semaphore signal operation is executedpWaitSemaphores created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR the corresponding element of VkTimelineSemaphoreSubmitInfoKHR::pWaitSemaphoreValues 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 than maxTimelineSemaphoreValueDifference.pSignalSemaphores created with a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_TIMELINE_KHR the corresponding element of VkTimelineSemaphoreSubmitInfoKHR::pSignalSemaphoreValues 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 than maxTimelineSemaphoreValueDifference.pWaitDstStageMask must not contain PIPELINE_STAGE_MESH_SHADER_BIT_NVpWaitDstStageMask must not contain PIPELINE_STAGE_TASK_SHADER_BIT_NVsType must be STRUCTURE_TYPE_SUBMIT_INFOpNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkD3D12FenceSubmitInfoKHR, VkDeviceGroupSubmitInfo, VkPerformanceQuerySubmitInfoKHR, VkProtectedSubmitInfo, VkTimelineSemaphoreSubmitInfoKHR, VkWin32KeyedMutexAcquireReleaseInfoKHR, or VkWin32KeyedMutexAcquireReleaseInfoNVsType member in the pNext chain must be uniquewaitSemaphoreCount is not 0, pWaitSemaphores must be a valid pointer to an array of waitSemaphoreCount valid VkSemaphore handleswaitSemaphoreCount is not 0, pWaitDstStageMask must be a valid pointer to an array of waitSemaphoreCount valid combinations of VkPipelineStageFlagBits valuespWaitDstStageMask must not be 0commandBufferCount is not 0, pCommandBuffers must be a valid pointer to an array of commandBufferCount valid VkCommandBuffer handlessignalSemaphoreCount is not 0, pSignalSemaphores must be a valid pointer to an array of signalSemaphoreCount valid VkSemaphore handlespCommandBuffers, the elements of pSignalSemaphores, and the elements of pWaitSemaphores that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevicesType – the type of this structure.pNext – NULL or a pointer to an extension-specific structure.waitSemaphoreCount – the number of semaphores upon which to wait before executing the command buffers for the batch.pWaitSemaphores – a pointer to an array of VkSemaphore handles upon which to wait before the command buffers for this batch begin execution. If semaphores to wait on are provided, they define a semaphore wait operation.pWaitDstStageMask – a pointer to an array of pipeline stages at which each corresponding semaphore wait will occur.commandBufferCount – the number of command buffers to execute in the batch.pCommandBuffers – a pointer to an array of VkCommandBuffer handles to execute in the batch.signalSemaphoreCount – the number of semaphores to be signaled once the commands specified in pCommandBuffers have completed execution.pSignalSemaphores – a pointer to an array of VkSemaphore handles which will be signaled when the command buffers for this batch have completed execution. If semaphores to be signaled are provided, they define a semaphore signal operation.
struct VkSubmitInfo {
VkStructureType sType;
void const * pNext;
uint32_t waitSemaphoreCount;
VkSemaphore const * pWaitSemaphores;
VkPipelineStageFlags const * pWaitDstStageMask;
uint32_t commandBufferCount;
VkCommandBuffer const * pCommandBuffers;
uint32_t signalSemaphoreCount;
VkSemaphore const * pSignalSemaphores;
}| Modifier and Type | Class and Description |
|---|---|
static class |
VkSubmitInfo.Buffer
An array of
VkSubmitInfo structs. |
| Modifier and Type | Field and Description |
|---|---|
static int |
ALIGNOF
The struct alignment in bytes.
|
static int |
COMMANDBUFFERCOUNT
The struct member offsets.
|
static int |
PCOMMANDBUFFERS
The struct member offsets.
|
static int |
PNEXT
The struct member offsets.
|
static int |
PSIGNALSEMAPHORES
The struct member offsets.
|
static int |
PWAITDSTSTAGEMASK
The struct member offsets.
|
static int |
PWAITSEMAPHORES
The struct member offsets.
|
static int |
SIGNALSEMAPHORECOUNT
The struct member offsets.
|
static int |
SIZEOF
The struct size in bytes.
|
static int |
STYPE
The struct member offsets.
|
static int |
WAITSEMAPHORECOUNT
The struct member offsets.
|
| Constructor and Description |
|---|
VkSubmitInfo(java.nio.ByteBuffer container)
Creates a
VkSubmitInfo instance at the current position of the specified ByteBuffer container. |
| Modifier and Type | Method and Description |
|---|---|
static VkSubmitInfo |
calloc()
Returns a new
VkSubmitInfo instance allocated with memCalloc. |
static VkSubmitInfo.Buffer |
calloc(int capacity)
Returns a new
VkSubmitInfo.Buffer instance allocated with memCalloc. |
static VkSubmitInfo |
callocStack()
Returns a new
VkSubmitInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero. |
static VkSubmitInfo.Buffer |
callocStack(int capacity)
Returns a new
VkSubmitInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero. |
static VkSubmitInfo.Buffer |
callocStack(int capacity,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkSubmitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero. |
static VkSubmitInfo |
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a new
VkSubmitInfo instance allocated on the specified MemoryStack and initializes all its bits to zero. |
int |
commandBufferCount()
Returns the value of the
commandBufferCount field. |
static VkSubmitInfo |
create()
Returns a new
VkSubmitInfo instance allocated with BufferUtils. |
static VkSubmitInfo.Buffer |
create(int capacity)
Returns a new
VkSubmitInfo.Buffer instance allocated with BufferUtils. |
static VkSubmitInfo |
create(long address)
Returns a new
VkSubmitInfo instance for the specified memory address. |
static VkSubmitInfo.Buffer |
create(long address,
int capacity)
Create a
VkSubmitInfo.Buffer instance at the specified memory. |
static VkSubmitInfo |
createSafe(long address)
|
static VkSubmitInfo.Buffer |
createSafe(long address,
int capacity)
|
static VkSubmitInfo |
malloc()
Returns a new
VkSubmitInfo instance allocated with memAlloc. |
static VkSubmitInfo.Buffer |
malloc(int capacity)
Returns a new
VkSubmitInfo.Buffer instance allocated with memAlloc. |
static VkSubmitInfo |
mallocStack()
Returns a new
VkSubmitInfo instance allocated on the thread-local MemoryStack. |
static VkSubmitInfo.Buffer |
mallocStack(int capacity)
Returns a new
VkSubmitInfo.Buffer instance allocated on the thread-local MemoryStack. |
static VkSubmitInfo.Buffer |
mallocStack(int capacity,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkSubmitInfo.Buffer instance allocated on the specified MemoryStack. |
static VkSubmitInfo |
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a new
VkSubmitInfo instance allocated on the specified MemoryStack. |
static int |
ncommandBufferCount(long struct)
Unsafe version of
commandBufferCount(). |
static void |
ncommandBufferCount(long struct,
int value)
Sets the specified value to the
commandBufferCount field of the specified struct. |
static org.lwjgl.PointerBuffer |
npCommandBuffers(long struct)
Unsafe version of
pCommandBuffers. |
static void |
npCommandBuffers(long struct,
org.lwjgl.PointerBuffer value)
Unsafe version of
pCommandBuffers. |
static long |
npNext(long struct)
Unsafe version of
pNext(). |
static void |
npNext(long struct,
long value)
Unsafe version of
pNext. |
static java.nio.LongBuffer |
npSignalSemaphores(long struct)
Unsafe version of
pSignalSemaphores. |
static void |
npSignalSemaphores(long struct,
java.nio.LongBuffer value)
Unsafe version of
pSignalSemaphores. |
static java.nio.IntBuffer |
npWaitDstStageMask(long struct)
Unsafe version of
pWaitDstStageMask. |
static void |
npWaitDstStageMask(long struct,
java.nio.IntBuffer value)
Unsafe version of
pWaitDstStageMask. |
static java.nio.LongBuffer |
npWaitSemaphores(long struct)
Unsafe version of
pWaitSemaphores. |
static void |
npWaitSemaphores(long struct,
java.nio.LongBuffer value)
Unsafe version of
pWaitSemaphores. |
static int |
nsignalSemaphoreCount(long struct)
Unsafe version of
signalSemaphoreCount(). |
static void |
nsignalSemaphoreCount(long struct,
int value)
Sets the specified value to the
signalSemaphoreCount 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 |
nwaitSemaphoreCount(long struct)
Unsafe version of
waitSemaphoreCount(). |
static void |
nwaitSemaphoreCount(long struct,
int value)
Sets the specified value to the
waitSemaphoreCount field of the specified struct. |
org.lwjgl.PointerBuffer |
pCommandBuffers()
Returns a
PointerBuffer view of the data pointed to by the pCommandBuffers field. |
VkSubmitInfo |
pCommandBuffers(org.lwjgl.PointerBuffer value)
Sets the address of the specified
PointerBuffer to the pCommandBuffers field. |
long |
pNext()
Returns the value of the
pNext field. |
VkSubmitInfo |
pNext(long value)
Sets the specified value to the
pNext field. |
java.nio.LongBuffer |
pSignalSemaphores()
Returns a
LongBuffer view of the data pointed to by the pSignalSemaphores field. |
VkSubmitInfo |
pSignalSemaphores(java.nio.LongBuffer value)
Sets the address of the specified
LongBuffer to the pSignalSemaphores field. |
java.nio.IntBuffer |
pWaitDstStageMask()
Returns a
IntBuffer view of the data pointed to by the pWaitDstStageMask field. |
VkSubmitInfo |
pWaitDstStageMask(java.nio.IntBuffer value)
Sets the address of the specified
IntBuffer to the pWaitDstStageMask field. |
java.nio.LongBuffer |
pWaitSemaphores()
Returns a
LongBuffer view of the data pointed to by the pWaitSemaphores field. |
VkSubmitInfo |
pWaitSemaphores(java.nio.LongBuffer value)
Sets the address of the specified
LongBuffer to the pWaitSemaphores field. |
VkSubmitInfo |
set(int sType,
long pNext,
int waitSemaphoreCount,
java.nio.LongBuffer pWaitSemaphores,
java.nio.IntBuffer pWaitDstStageMask,
org.lwjgl.PointerBuffer pCommandBuffers,
java.nio.LongBuffer pSignalSemaphores)
Initializes this struct with the specified values.
|
VkSubmitInfo |
set(VkSubmitInfo src)
Copies the specified struct data to this struct.
|
int |
signalSemaphoreCount()
Returns the value of the
signalSemaphoreCount field. |
int |
sizeof() |
int |
sType()
Returns the value of the
sType field. |
VkSubmitInfo |
sType(int value)
Sets the specified value to the
sType field. |
static void |
validate(long struct)
Validates pointer members that should not be
NULL. |
static void |
validate(long array,
int count)
Calls
validate(long) for each struct contained in the specified struct array. |
int |
waitSemaphoreCount()
Returns the value of the
waitSemaphoreCount field. |
VkSubmitInfo |
waitSemaphoreCount(int value)
Sets the specified value to the
waitSemaphoreCount field. |
public static final int SIZEOF
public static final int ALIGNOF
public static final int STYPE
public static final int PNEXT
public static final int WAITSEMAPHORECOUNT
public static final int PWAITSEMAPHORES
public static final int PWAITDSTSTAGEMASK
public static final int COMMANDBUFFERCOUNT
public static final int PCOMMANDBUFFERS
public static final int SIGNALSEMAPHORECOUNT
public static final int PSIGNALSEMAPHORES
public VkSubmitInfo(java.nio.ByteBuffer container)
VkSubmitInfo 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.
public int sizeof()
sizeof in class org.lwjgl.system.Structpublic int sType()
sType field.public long pNext()
pNext field.public int waitSemaphoreCount()
waitSemaphoreCount field.@Nullable public java.nio.LongBuffer pWaitSemaphores()
LongBuffer view of the data pointed to by the pWaitSemaphores field.@Nullable public java.nio.IntBuffer pWaitDstStageMask()
IntBuffer view of the data pointed to by the pWaitDstStageMask field.public int commandBufferCount()
commandBufferCount field.@Nullable public org.lwjgl.PointerBuffer pCommandBuffers()
PointerBuffer view of the data pointed to by the pCommandBuffers field.public int signalSemaphoreCount()
signalSemaphoreCount field.@Nullable public java.nio.LongBuffer pSignalSemaphores()
LongBuffer view of the data pointed to by the pSignalSemaphores field.public VkSubmitInfo sType(int value)
sType field.public VkSubmitInfo pNext(long value)
pNext field.public VkSubmitInfo waitSemaphoreCount(int value)
waitSemaphoreCount field.public VkSubmitInfo pWaitSemaphores(@Nullable java.nio.LongBuffer value)
LongBuffer to the pWaitSemaphores field.public VkSubmitInfo pWaitDstStageMask(@Nullable java.nio.IntBuffer value)
IntBuffer to the pWaitDstStageMask field.public VkSubmitInfo pCommandBuffers(@Nullable org.lwjgl.PointerBuffer value)
PointerBuffer to the pCommandBuffers field.public VkSubmitInfo pSignalSemaphores(@Nullable java.nio.LongBuffer value)
LongBuffer to the pSignalSemaphores field.public VkSubmitInfo set(int sType, long pNext, int waitSemaphoreCount, @Nullable java.nio.LongBuffer pWaitSemaphores, @Nullable java.nio.IntBuffer pWaitDstStageMask, @Nullable org.lwjgl.PointerBuffer pCommandBuffers, @Nullable java.nio.LongBuffer pSignalSemaphores)
public VkSubmitInfo set(VkSubmitInfo src)
src - the source structpublic static VkSubmitInfo malloc()
VkSubmitInfo instance allocated with memAlloc. The instance must be explicitly freed.public static VkSubmitInfo calloc()
VkSubmitInfo instance allocated with memCalloc. The instance must be explicitly freed.public static VkSubmitInfo create()
VkSubmitInfo instance allocated with BufferUtils.public static VkSubmitInfo create(long address)
VkSubmitInfo instance for the specified memory address.@Nullable public static VkSubmitInfo createSafe(long address)
public static VkSubmitInfo.Buffer malloc(int capacity)
VkSubmitInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkSubmitInfo.Buffer calloc(int capacity)
VkSubmitInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkSubmitInfo.Buffer create(int capacity)
VkSubmitInfo.Buffer instance allocated with BufferUtils.capacity - the buffer capacitypublic static VkSubmitInfo.Buffer create(long address, int capacity)
VkSubmitInfo.Buffer instance at the specified memory.address - the memory addresscapacity - the buffer capacity@Nullable public static VkSubmitInfo.Buffer createSafe(long address, int capacity)
public static VkSubmitInfo mallocStack()
VkSubmitInfo instance allocated on the thread-local MemoryStack.public static VkSubmitInfo callocStack()
VkSubmitInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.public static VkSubmitInfo mallocStack(org.lwjgl.system.MemoryStack stack)
VkSubmitInfo instance allocated on the specified MemoryStack.stack - the stack from which to allocatepublic static VkSubmitInfo callocStack(org.lwjgl.system.MemoryStack stack)
VkSubmitInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatepublic static VkSubmitInfo.Buffer mallocStack(int capacity)
VkSubmitInfo.Buffer instance allocated on the thread-local MemoryStack.capacity - the buffer capacitypublic static VkSubmitInfo.Buffer callocStack(int capacity)
VkSubmitInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.capacity - the buffer capacitypublic static VkSubmitInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkSubmitInfo.Buffer instance allocated on the specified MemoryStack.stack - the stack from which to allocatecapacity - the buffer capacitypublic static VkSubmitInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkSubmitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatecapacity - the buffer capacitypublic static int nsType(long struct)
sType().public static long npNext(long struct)
pNext().public static int nwaitSemaphoreCount(long struct)
waitSemaphoreCount().@Nullable public static java.nio.LongBuffer npWaitSemaphores(long struct)
pWaitSemaphores.@Nullable public static java.nio.IntBuffer npWaitDstStageMask(long struct)
pWaitDstStageMask.public static int ncommandBufferCount(long struct)
commandBufferCount().@Nullable public static org.lwjgl.PointerBuffer npCommandBuffers(long struct)
pCommandBuffers.public static int nsignalSemaphoreCount(long struct)
signalSemaphoreCount().@Nullable public static java.nio.LongBuffer npSignalSemaphores(long struct)
pSignalSemaphores.public static void nsType(long struct,
int value)
sType.public static void npNext(long struct,
long value)
pNext.public static void nwaitSemaphoreCount(long struct,
int value)
waitSemaphoreCount field of the specified struct.public static void npWaitSemaphores(long struct,
@Nullable
java.nio.LongBuffer value)
pWaitSemaphores.public static void npWaitDstStageMask(long struct,
@Nullable
java.nio.IntBuffer value)
pWaitDstStageMask.public static void ncommandBufferCount(long struct,
int value)
commandBufferCount field of the specified struct.public static void npCommandBuffers(long struct,
@Nullable
org.lwjgl.PointerBuffer value)
pCommandBuffers.public static void nsignalSemaphoreCount(long struct,
int value)
signalSemaphoreCount field of the specified struct.public static void npSignalSemaphores(long struct,
@Nullable
java.nio.LongBuffer value)
pSignalSemaphores.public static void validate(long struct)
NULL.struct - the struct to validatepublic static void validate(long array,
int count)
validate(long) for each struct contained in the specified struct array.array - the struct array to validatecount - the number of structs in arrayCopyright LWJGL. All Rights Reserved. License terms.