Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCommandBufferSubmitInfo

extends Struct<VkCommandBufferSubmitInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkCommandBufferSubmitInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a command buffer submission.
Valid Usage
Valid Usage (Implicit)
See Also

VkSubmitInfo2

Layout


struct VkCommandBufferSubmitInfo {
    VkStructureType sType;
    void const * pNext;
    VkCommandBuffer commandBuffer;
    uint32_t deviceMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMMANDBUFFER

The struct member offsets.

public static final int
DEVICEMASK

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkCommandBufferSubmitInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCommandBufferSubmitInfo
calloc()

Returns a new VkCommandBufferSubmitInfo instance allocated with memCalloc.

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

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public long
commandBuffer()

a VkCommandBuffer to be submitted for execution.

public VkCommandBufferSubmitInfo
commandBuffer(VkCommandBuffer value)

Sets the specified value to the commandBuffer field.

protected VkCommandBufferSubmitInfo
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 VkCommandBufferSubmitInfo
create()

Returns a new VkCommandBufferSubmitInfo instance allocated with BufferUtils.

public static VkCommandBufferSubmitInfo
create(long address)

Returns a new VkCommandBufferSubmitInfo instance for the specified memory address.

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

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with BufferUtils.

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

Create a VkCommandBufferSubmitInfo.Buffer instance at the specified memory.

public static VkCommandBufferSubmitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
deviceMask()

a bitmask indicating which devices in a device group execute the command buffer.

public VkCommandBufferSubmitInfo
deviceMask(int value)

Sets the specified value to the deviceMask field.

public static VkCommandBufferSubmitInfo
malloc()

Returns a new VkCommandBufferSubmitInfo instance allocated with memAlloc.

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

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkCommandBufferSubmitInfo instance allocated on the specified MemoryStack.

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

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

public static long
ncommandBuffer(long struct)

Unsafe version of commandBuffer.

public static void
ncommandBuffer(long struct, VkCommandBuffer value)

Unsafe version of commandBuffer.

public static int
ndeviceMask(long struct)

Unsafe version of deviceMask.

public static void
ndeviceMask(long struct, int value)

Unsafe version of deviceMask.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCommandBufferSubmitInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkCommandBufferSubmitInfo
set(int sType, long pNext, VkCommandBuffer commandBuffer, int deviceMask)

Initializes this struct with the specified values.

public VkCommandBufferSubmitInfo

Returns:

this struct
set
(VkCommandBufferSubmitInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkCommandBufferSubmitInfo
sType(int value)

Sets the specified value to the sType field.

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

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COMMANDBUFFERback to summary
public static final int COMMANDBUFFER

The struct member offsets.

DEVICEMASKback to summary
public static final int DEVICEMASK

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkCommandBufferSubmitInfoback to summary
protected VkCommandBufferSubmitInfo(long address, ByteBuffer container)
VkCommandBufferSubmitInfoback to summary
public VkCommandBufferSubmitInfo(ByteBuffer container)

Creates a VkCommandBufferSubmitInfo 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.

Method Detail

callocback to summary
public static VkCommandBufferSubmitInfo calloc()

Returns a new VkCommandBufferSubmitInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkCommandBufferSubmitInfo.Buffer calloc(int capacity)

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCommandBufferSubmitInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkCommandBufferSubmitInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

commandBufferback to summary
public long commandBuffer()

a VkCommandBuffer to be submitted for execution.

Annotations
@NativeType:VkCommandBuffer
commandBufferback to summary
public VkCommandBufferSubmitInfo commandBuffer(VkCommandBuffer value)

Sets the specified value to the commandBuffer field.

createback to summary
protected VkCommandBufferSubmitInfo create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkCommandBufferSubmitInfo create()

Returns a new VkCommandBufferSubmitInfo instance allocated with BufferUtils.

createback to summary
public static VkCommandBufferSubmitInfo create(long address)

Returns a new VkCommandBufferSubmitInfo instance for the specified memory address.

createback to summary
public static VkCommandBufferSubmitInfo.Buffer create(int capacity)

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkCommandBufferSubmitInfo.Buffer create(long address, int capacity)

Create a VkCommandBufferSubmitInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCommandBufferSubmitInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCommandBufferSubmitInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceMaskback to summary
public int deviceMask()

a bitmask indicating which devices in a device group execute the command buffer. A deviceMask of 0 is equivalent to setting all bits corresponding to valid devices in the group to 1.

Annotations
@NativeType:uint32_t
deviceMaskback to summary
public VkCommandBufferSubmitInfo deviceMask(int value)

Sets the specified value to the deviceMask field.

mallocback to summary
public static VkCommandBufferSubmitInfo malloc()

Returns a new VkCommandBufferSubmitInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkCommandBufferSubmitInfo.Buffer malloc(int capacity)

Returns a new VkCommandBufferSubmitInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCommandBufferSubmitInfo malloc(MemoryStack stack)

Returns a new VkCommandBufferSubmitInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkCommandBufferSubmitInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncommandBufferback to summary
public static long ncommandBuffer(long struct)

Unsafe version of commandBuffer.

ncommandBufferback to summary
public static void ncommandBuffer(long struct, VkCommandBuffer value)

Unsafe version of commandBuffer.

ndeviceMaskback to summary
public static int ndeviceMask(long struct)

Unsafe version of deviceMask.

ndeviceMaskback to summary
public static void ndeviceMask(long struct, int value)

Unsafe version of deviceMask.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandBufferSubmitInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkCommandBufferSubmitInfo set(int sType, long pNext, VkCommandBuffer commandBuffer, int deviceMask)

Initializes this struct with the specified values.

setback to summary
public VkCommandBufferSubmitInfo set(VkCommandBufferSubmitInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkCommandBufferSubmitInfo

the source struct

Returns:VkCommandBufferSubmitInfo

this struct

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandBufferSubmitInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkCommandBufferSubmitInfo sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkCommandBufferSubmitInfo.Buffer

extends StructBuffer<VkCommandBufferSubmitInfo, VkCommandBufferSubmitInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkCommandBufferSubmitInfoKHR.Buffer

An array of VkCommandBufferSubmitInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkCommandBufferSubmitInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCommandBufferSubmitInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkCommandBufferSubmitInfo#commandBuffer field.
commandBuffer
()

public VkCommandBufferSubmitInfo.Buffer
commandBuffer(VkCommandBuffer value)

Sets the specified value to the VkCommandBufferSubmitInfo#commandBuffer field.

public int

Returns:

the value of the VkCommandBufferSubmitInfo#deviceMask field.
deviceMask
()

public VkCommandBufferSubmitInfo.Buffer
deviceMask(int value)

Sets the specified value to the VkCommandBufferSubmitInfo#deviceMask field.

protected VkCommandBufferSubmitInfo
public long

Returns:

the value of the VkCommandBufferSubmitInfo#pNext field.
pNext
()

public VkCommandBufferSubmitInfo.Buffer
pNext(long value)

Sets the specified value to the VkCommandBufferSubmitInfo#pNext field.

protected VkCommandBufferSubmitInfo.Buffer
public int

Returns:

the value of the VkCommandBufferSubmitInfo#sType field.
sType
()

public VkCommandBufferSubmitInfo.Buffer
sType(int value)

Sets the specified value to the VkCommandBufferSubmitInfo#sType field.

public VkCommandBufferSubmitInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCommandBufferSubmitInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCommandBufferSubmitInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCommandBufferSubmitInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

commandBufferback to summary
public long commandBuffer()
Returns:long

the value of the VkCommandBufferSubmitInfo#commandBuffer field.

Annotations
@NativeType:VkCommandBuffer
commandBufferback to summary
public VkCommandBufferSubmitInfo.Buffer commandBuffer(VkCommandBuffer value)

Sets the specified value to the VkCommandBufferSubmitInfo#commandBuffer field.

deviceMaskback to summary
public int deviceMask()
Returns:int

the value of the VkCommandBufferSubmitInfo#deviceMask field.

Annotations
@NativeType:uint32_t
deviceMaskback to summary
public VkCommandBufferSubmitInfo.Buffer deviceMask(int value)

Sets the specified value to the VkCommandBufferSubmitInfo#deviceMask field.

getElementFactoryback to summary
protected VkCommandBufferSubmitInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkCommandBufferSubmitInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandBufferSubmitInfo.Buffer pNext(long value)

Sets the specified value to the VkCommandBufferSubmitInfo#pNext field.

selfback to summary
protected VkCommandBufferSubmitInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkCommandBufferSubmitInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandBufferSubmitInfo.Buffer sType(int value)

Sets the specified value to the VkCommandBufferSubmitInfo#sType field.

sType$Defaultback to summary
public VkCommandBufferSubmitInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFO value to the VkCommandBufferSubmitInfo#sType field.