Package org.lwjgl.vulkan
Class VkCommandBufferAllocateInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkCommandBufferAllocateInfo
extends Struct<VkCommandBufferAllocateInfo>
implements NativeResource
Structure specifying the allocation parameters for command buffer object.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
pNext
must beNULL
commandPool
must be a validVkCommandPool
handlelevel
must be a validVkCommandBufferLevel
value
See Also
Layout
struct VkCommandBufferAllocateInfo {
VkStructureType sType()
;
void const * pNext()
;
VkCommandPool commandPool()
;
VkCommandBufferLevel level()
;
uint32_t commandBufferCount()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkCommandBufferAllocateInfo
(ByteBuffer container) Creates aVkCommandBufferAllocateInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkCommandBufferAllocateInfo
calloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferAllocateInfo
calloc
(MemoryStack stack) Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferAllocateInfo
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkCommandBufferAllocateInfo
callocStack
(MemoryStack stack) Deprecated.int
the number of command buffers to allocate from the pool.commandBufferCount
(int value) Sets the specified value to thecommandBufferCount()
field.long
the command pool from which the command buffers are allocated.commandPool
(long value) Sets the specified value to thecommandPool()
field.static VkCommandBufferAllocateInfo
create()
Returns a newVkCommandBufferAllocateInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withBufferUtils
.static VkCommandBufferAllocateInfo
create
(long address) Returns a newVkCommandBufferAllocateInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkCommandBufferAllocateInfo.Buffer
instance at the specified memory.static VkCommandBufferAllocateInfo
createSafe
(long address) createSafe
(long address, int capacity) int
level()
aVkCommandBufferLevel
value specifying the command buffer level.level
(int value) Sets the specified value to thelevel()
field.static VkCommandBufferAllocateInfo
malloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferAllocateInfo
malloc
(MemoryStack stack) Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
.static VkCommandBufferAllocateInfo
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkCommandBufferAllocateInfo
mallocStack
(MemoryStack stack) Deprecated.static int
ncommandBufferCount
(long struct) Unsafe version ofcommandBufferCount()
.static void
ncommandBufferCount
(long struct, int value) Unsafe version ofcommandBufferCount
.static long
ncommandPool
(long struct) Unsafe version ofcommandPool()
.static void
ncommandPool
(long struct, long value) Unsafe version ofcommandPool
.static int
nlevel
(long struct) Unsafe version oflevel()
.static void
nlevel
(long struct, int value) Unsafe version oflevel
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, long commandPool, int level, int commandBufferCount) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
COMMANDPOOL
public static final int COMMANDPOOLThe struct member offsets. -
LEVEL
public static final int LEVELThe struct member offsets. -
COMMANDBUFFERCOUNT
public static final int COMMANDBUFFERCOUNTThe struct member offsets.
-
-
Constructor Details
-
VkCommandBufferAllocateInfo
Creates aVkCommandBufferAllocateInfo
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkCommandBufferAllocateInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
commandPool
public long commandPool()the command pool from which the command buffers are allocated. -
level
public int level()aVkCommandBufferLevel
value specifying the command buffer level. -
commandBufferCount
public int commandBufferCount()the number of command buffers to allocate from the pool. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
commandPool
Sets the specified value to thecommandPool()
field. -
level
Sets the specified value to thelevel()
field. -
commandBufferCount
Sets the specified value to thecommandBufferCount()
field. -
set
public VkCommandBufferAllocateInfo set(int sType, long pNext, long commandPool, int level, int commandBufferCount) 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 newVkCommandBufferAllocateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkCommandBufferAllocateInfo
instance allocated withBufferUtils
. -
create
Returns a newVkCommandBufferAllocateInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkCommandBufferAllocateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkCommandBufferAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
ncommandPool
public static long ncommandPool(long struct) Unsafe version ofcommandPool()
. -
nlevel
public static int nlevel(long struct) Unsafe version oflevel()
. -
ncommandBufferCount
public static int ncommandBufferCount(long struct) Unsafe version ofcommandBufferCount()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
ncommandPool
public static void ncommandPool(long struct, long value) Unsafe version ofcommandPool
. -
nlevel
public static void nlevel(long struct, int value) Unsafe version oflevel
. -
ncommandBufferCount
public static void ncommandBufferCount(long struct, int value) Unsafe version ofcommandBufferCount
.
-