Package org.lwjgl.vulkan
Class VkCommandBufferAllocateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkCommandBufferAllocateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkCommandBufferAllocateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a command buffer should be allocated.
Valid Usage
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
pNext
must beNULL
commandPool
must be a validVkCommandPool
handlelevel
must be a validVkCommandBufferLevel
valuecommandBufferCount
must be greater than 0
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
pNext
– reserved for use by extensionscommandPool
– the name of the command pool that the command buffers allocate their memory fromlevel
– determines whether the command buffers are primary or secondary command buffers. One of:COMMAND_BUFFER_LEVEL_PRIMARY
COMMAND_BUFFER_LEVEL_SECONDARY
commandBufferCount
– the number of command buffers to allocate from the pool
Layout
struct VkCommandBufferAllocateInfo { VkStructureType sType; const void * pNext; VkCommandPool commandPool; VkCommandBufferLevel level; uint32_t commandBufferCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkCommandBufferAllocateInfo.Buffer
An array ofVkCommandBufferAllocateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkCommandBufferAllocateInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferAllocateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkCommandBufferAllocateInfo
calloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemCalloc
.static VkCommandBufferAllocateInfo.Buffer
calloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemCalloc
.static VkCommandBufferAllocateInfo
callocStack()
Returns a newVkCommandBufferAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferAllocateInfo.Buffer
callocStack(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferAllocateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferAllocateInfo
callocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.int
commandBufferCount()
Returns the value of thecommandBufferCount
field.VkCommandBufferAllocateInfo
commandBufferCount(int value)
Sets the specified value to thecommandBufferCount
field.long
commandPool()
Returns the value of thecommandPool
field.VkCommandBufferAllocateInfo
commandPool(long value)
Sets the specified value to thecommandPool
field.static VkCommandBufferAllocateInfo
create()
Returns a newVkCommandBufferAllocateInfo
instance allocated withBufferUtils
.static VkCommandBufferAllocateInfo.Buffer
create(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withBufferUtils
.static VkCommandBufferAllocateInfo
create(long address)
Returns a newVkCommandBufferAllocateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkCommandBufferAllocateInfo.Buffer
create(long address, int capacity)
Create aVkCommandBufferAllocateInfo.Buffer
instance at the specified memory.int
level()
Returns the value of thelevel
field.VkCommandBufferAllocateInfo
level(int value)
Sets the specified value to thelevel
field.static VkCommandBufferAllocateInfo
malloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemAlloc
.static VkCommandBufferAllocateInfo.Buffer
malloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemAlloc
.static VkCommandBufferAllocateInfo
mallocStack()
Returns a newVkCommandBufferAllocateInfo
instance allocated on the thread-localMemoryStack
.static VkCommandBufferAllocateInfo.Buffer
mallocStack(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkCommandBufferAllocateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferAllocateInfo
mallocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
.VkCommandBufferAllocateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkCommandBufferAllocateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkCommandBufferAllocateInfo
set(int sType, long pNext, long commandPool, int level, int commandBufferCount)
Initializes this struct with the specified values.VkCommandBufferAllocateInfo
set(VkCommandBufferAllocateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkCommandBufferAllocateInfo
sType(int value)
Sets the specified 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
-
-
-
-
Constructor Detail
-
VkCommandBufferAllocateInfo
public VkCommandBufferAllocateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
commandPool
public long commandPool()
Returns the value of thecommandPool
field.
-
level
public int level()
Returns the value of thelevel
field.
-
commandBufferCount
public int commandBufferCount()
Returns the value of thecommandBufferCount
field.
-
sType
public VkCommandBufferAllocateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkCommandBufferAllocateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
commandPool
public VkCommandBufferAllocateInfo commandPool(long value)
Sets the specified value to thecommandPool
field.
-
level
public VkCommandBufferAllocateInfo level(int value)
Sets the specified value to thelevel
field.
-
commandBufferCount
public VkCommandBufferAllocateInfo commandBufferCount(int value)
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.
-
nset
public VkCommandBufferAllocateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkCommandBufferAllocateInfo set(VkCommandBufferAllocateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkCommandBufferAllocateInfo malloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkCommandBufferAllocateInfo calloc()
Returns a newVkCommandBufferAllocateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkCommandBufferAllocateInfo create()
Returns a newVkCommandBufferAllocateInfo
instance allocated withBufferUtils
.
-
create
public static VkCommandBufferAllocateInfo create(long address)
Returns a newVkCommandBufferAllocateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkCommandBufferAllocateInfo.Buffer malloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkCommandBufferAllocateInfo.Buffer calloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferAllocateInfo.Buffer create(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferAllocateInfo.Buffer create(long address, int capacity)
Create aVkCommandBufferAllocateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkCommandBufferAllocateInfo mallocStack()
Returns a newVkCommandBufferAllocateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkCommandBufferAllocateInfo callocStack()
Returns a newVkCommandBufferAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkCommandBufferAllocateInfo mallocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandBufferAllocateInfo callocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkCommandBufferAllocateInfo.Buffer mallocStack(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkCommandBufferAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-