Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubmitInfo

extends Struct<VkSubmitInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a queue submit operation.
Description

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.

Valid Usage
Valid Usage (Implicit)
See Also

QueueSubmit

Layout


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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSubmitInfo.Buffer

An array of VkSubmitInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMMANDBUFFERCOUNT

The struct member offsets.

public static final int
PCOMMANDBUFFERS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSIGNALSEMAPHORES

The struct member offsets.

public static final int
PWAITDSTSTAGEMASK

The struct member offsets.

public static final int
PWAITSEMAPHORES

The struct member offsets.

public static final int
SIGNALSEMAPHORECOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
WAITSEMAPHORECOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSubmitInfo(long address, ByteBuffer container)

public
VkSubmitInfo(ByteBuffer container)

Creates a VkSubmitInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSubmitInfo
calloc()

Returns a new VkSubmitInfo instance allocated with memCalloc.

public static VkSubmitInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkSubmitInfo.Buffer instance allocated with memCalloc.

public static VkSubmitInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSubmitInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSubmitInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSubmitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSubmitInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
commandBufferCount()

the number of command buffers to execute in the batch.

protected VkSubmitInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSubmitInfo
create()

Returns a new VkSubmitInfo instance allocated with BufferUtils.

public static VkSubmitInfo
create(long address)

Returns a new VkSubmitInfo instance for the specified memory address.

public static VkSubmitInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkSubmitInfo.Buffer instance allocated with BufferUtils.

public static VkSubmitInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkSubmitInfo.Buffer instance at the specified memory.

public static VkSubmitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkSubmitInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkSubmitInfo
malloc()

Returns a new VkSubmitInfo instance allocated with memAlloc.

public static VkSubmitInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkSubmitInfo.Buffer instance allocated with memAlloc.

public static VkSubmitInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSubmitInfo instance allocated on the specified MemoryStack.

public static VkSubmitInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkSubmitInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubmitInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ncommandBufferCount(long struct)

Unsafe version of commandBufferCount.

public static void
ncommandBufferCount(long struct, int value)

Sets the specified value to the commandBufferCount field of the specified struct.

public static PointerBuffer
npCommandBuffers(long struct)

Unsafe version of pCommandBuffers.

public static void
npCommandBuffers(long struct, PointerBuffer value)

Unsafe version of pCommandBuffers.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static LongBuffer
npSignalSemaphores(long struct)

Unsafe version of pSignalSemaphores.

public static void
npSignalSemaphores(long struct, LongBuffer value)

Unsafe version of pSignalSemaphores.

public static IntBuffer
npWaitDstStageMask(long struct)

Unsafe version of pWaitDstStageMask.

public static void
npWaitDstStageMask(long struct, IntBuffer value)

Unsafe version of pWaitDstStageMask.

public static LongBuffer
npWaitSemaphores(long struct)

Unsafe version of pWaitSemaphores.

public static void
npWaitSemaphores(long struct, LongBuffer value)

Unsafe version of pWaitSemaphores.

public static int
nsignalSemaphoreCount(long struct)

Unsafe version of signalSemaphoreCount.

public static void
nsignalSemaphoreCount(long struct, int value)

Sets the specified value to the signalSemaphoreCount field of the specified struct.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nwaitSemaphoreCount(long struct)

Unsafe version of waitSemaphoreCount.

public static void
nwaitSemaphoreCount(long struct, int value)

Sets the specified value to the waitSemaphoreCount field of the specified struct.

public PointerBuffer
pCommandBuffers()

a pointer to an array of VkCommandBuffer handles to execute in the batch.

public VkSubmitInfo
pCommandBuffers(PointerBuffer value)

Sets the address of the specified PointerBuffer to the pCommandBuffers field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSubmitInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkSubmitInfo
pNext(VkAmigoProfilingSubmitInfoSEC value)

Prepends the specified VkAmigoProfilingSubmitInfoSEC value to the pNext chain.

public VkSubmitInfo
pNext(VkD3D12FenceSubmitInfoKHR value)

Prepends the specified VkD3D12FenceSubmitInfoKHR value to the pNext chain.

public VkSubmitInfo
pNext(VkDeviceGroupSubmitInfo value)

Prepends the specified VkDeviceGroupSubmitInfo value to the pNext chain.

public VkSubmitInfo
pNext(VkDeviceGroupSubmitInfoKHR value)

Prepends the specified VkDeviceGroupSubmitInfoKHR value to the pNext chain.

public VkSubmitInfo
pNext(VkFrameBoundaryEXT value)

Prepends the specified VkFrameBoundaryEXT value to the pNext chain.

public VkSubmitInfo
pNext(VkPerformanceQuerySubmitInfoKHR value)

Prepends the specified VkPerformanceQuerySubmitInfoKHR value to the pNext chain.

public VkSubmitInfo
pNext(VkProtectedSubmitInfo value)

Prepends the specified VkProtectedSubmitInfo value to the pNext chain.

public VkSubmitInfo
pNext(VkTimelineSemaphoreSubmitInfo value)

Prepends the specified VkTimelineSemaphoreSubmitInfo value to the pNext chain.

public VkSubmitInfo
pNext(VkTimelineSemaphoreSubmitInfoKHR value)

Prepends the specified VkTimelineSemaphoreSubmitInfoKHR value to the pNext chain.

public VkSubmitInfo
pNext(VkWin32KeyedMutexAcquireReleaseInfoKHR value)

Prepends the specified VkWin32KeyedMutexAcquireReleaseInfoKHR value to the pNext chain.

public VkSubmitInfo
pNext(VkWin32KeyedMutexAcquireReleaseInfoNV value)

Prepends the specified VkWin32KeyedMutexAcquireReleaseInfoNV value to the pNext chain.

public LongBuffer
pSignalSemaphores()

a pointer to an array of VkSemaphore handles which will be signaled when the command buffers for this batch have completed execution.

public VkSubmitInfo
pSignalSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the pSignalSemaphores field.

public IntBuffer
pWaitDstStageMask()

a pointer to an array of pipeline stages at which each corresponding semaphore wait will occur.

public VkSubmitInfo
pWaitDstStageMask(IntBuffer value)

Sets the address of the specified IntBuffer to the pWaitDstStageMask field.

public LongBuffer
pWaitSemaphores()

a pointer to an array of VkSemaphore handles upon which to wait before the command buffers for this batch begin execution.

public VkSubmitInfo
pWaitSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the pWaitSemaphores field.

public VkSubmitInfo
set(int sType, long pNext, int waitSemaphoreCount, LongBuffer pWaitSemaphores, IntBuffer pWaitDstStageMask, PointerBuffer pCommandBuffers, LongBuffer pSignalSemaphores)

Initializes this struct with the specified values.

public VkSubmitInfo

Returns:

this struct
set
(VkSubmitInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
signalSemaphoreCount()

the number of semaphores to be signaled once the commands specified in pCommandBuffers have completed execution.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkSubmitInfo
sType(int value)

Sets the specified value to the sType field.

public VkSubmitInfo
sType$Default()

Sets the STRUCTURE_TYPE_SUBMIT_INFO value to the sType field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
waitSemaphoreCount()

the number of semaphores upon which to wait before executing the command buffers for the batch.

public VkSubmitInfo
waitSemaphoreCount(int value)

Sets the specified value to the waitSemaphoreCount field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate