Package org.lwjgl.vulkan
Class VkCommandBufferSubmitInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCommandBufferSubmitInfo>
org.lwjgl.vulkan.VkCommandBufferSubmitInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkCommandBufferSubmitInfoKHR
public class VkCommandBufferSubmitInfo
extends org.lwjgl.system.Struct<VkCommandBufferSubmitInfo>
implements org.lwjgl.system.NativeResource
Structure specifying a command buffer submission.
Valid Usage
commandBuffermust not have been allocated withCOMMAND_BUFFER_LEVEL_SECONDARY- If
deviceMaskis not 0, it must be a valid device mask - If any render pass instance in
commandBufferwas recorded with aVkRenderPassStripeBeginInfoARMstructure in its pNext chain and did not specify theRENDERING_RESUMING_BITflag, aVkRenderPassStripeSubmitInfoARMmust be included in thepNextchain - If a
VkRenderPassStripeSubmitInfoARMis included in thepNextchain, the value ofVkRenderPassStripeSubmitInfoARM::stripeSemaphoreInfoCountmust be equal to the sum of theVkRenderPassStripeBeginInfoARM::stripeInfoCountparameters provided to render pass instances recorded incommandBufferthat did not specify theRENDERING_RESUMING_BITflag
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFOpNextmust beNULLor a pointer to a valid instance ofVkRenderPassStripeSubmitInfoARM- The
sTypevalue of each struct in thepNextchain must be unique commandBuffermust be a validVkCommandBufferhandle
See Also
Layout
struct VkCommandBufferSubmitInfo {
VkStructureType sType();
void const * pNext();
VkCommandBuffer commandBuffer();
uint32_t deviceMask();
}-
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 size in bytes.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
ConstructorsConstructorDescriptionVkCommandBufferSubmitInfo(ByteBuffer container) Creates aVkCommandBufferSubmitInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkCommandBufferSubmitInfocalloc()Returns a newVkCommandBufferSubmitInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandBufferSubmitInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.longaVkCommandBufferto be submitted for execution.commandBuffer(org.lwjgl.vulkan.VkCommandBuffer value) Sets the specified value to thecommandBuffer()field.static VkCommandBufferSubmitInfocreate()Returns a newVkCommandBufferSubmitInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withBufferUtils.static VkCommandBufferSubmitInfocreate(long address) Returns a newVkCommandBufferSubmitInfoinstance for the specified memory address.create(long address, int capacity) Create aVkCommandBufferSubmitInfo.Bufferinstance at the specified memory.static @Nullable VkCommandBufferSubmitInfocreateSafe(long address) static @Nullable VkCommandBufferSubmitInfo.BuffercreateSafe(long address, int capacity) inta bitmask indicating which devices in a device group execute the command buffer.deviceMask(int value) Sets the specified value to thedeviceMask()field.static VkCommandBufferSubmitInfomalloc()Returns a newVkCommandBufferSubmitInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkCommandBufferSubmitInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfoinstance allocated on the specifiedMemoryStack.static longncommandBuffer(long struct) Unsafe version ofcommandBuffer().static voidncommandBuffer(long struct, org.lwjgl.vulkan.VkCommandBuffer value) Unsafe version ofcommandBuffer.static intndeviceMask(long struct) Unsafe version ofdeviceMask().static voidndeviceMask(long struct, int value) Unsafe version ofdeviceMask.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkRenderPassStripeSubmitInfoARMvalue to thepNextchain.set(int sType, long pNext, org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int deviceMask) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.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. -
COMMANDBUFFER
public static final int COMMANDBUFFERThe struct member offsets. -
DEVICEMASK
public static final int DEVICEMASKThe struct member offsets.
-
-
Constructor Details
-
VkCommandBufferSubmitInfo
Creates aVkCommandBufferSubmitInfoinstance 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<VkCommandBufferSubmitInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
commandBuffer
public long commandBuffer()aVkCommandBufferto be submitted for execution. -
deviceMask
public int deviceMask()a bitmask indicating which devices in a device group execute the command buffer. AdeviceMaskof 0 is equivalent to setting all bits corresponding to valid devices in the group to 1. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkRenderPassStripeSubmitInfoARMvalue to thepNextchain. -
commandBuffer
Sets the specified value to thecommandBuffer()field. -
deviceMask
Sets the specified value to thedeviceMask()field. -
set
public VkCommandBufferSubmitInfo set(int sType, long pNext, org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int deviceMask) 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 newVkCommandBufferSubmitInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkCommandBufferSubmitInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkCommandBufferSubmitInfoinstance allocated withBufferUtils. -
create
Returns a newVkCommandBufferSubmitInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkCommandBufferSubmitInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkCommandBufferSubmitInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkCommandBufferSubmitInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkCommandBufferSubmitInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkCommandBufferSubmitInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferSubmitInfo.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(). -
ncommandBuffer
public static long ncommandBuffer(long struct) Unsafe version ofcommandBuffer(). -
ndeviceMask
public static int ndeviceMask(long struct) Unsafe version ofdeviceMask(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ncommandBuffer
public static void ncommandBuffer(long struct, org.lwjgl.vulkan.VkCommandBuffer value) Unsafe version ofcommandBuffer. -
ndeviceMask
public static void ndeviceMask(long struct, int value) Unsafe version ofdeviceMask. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-