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
sTypemust beSTRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFOpNextmust beNULLcommandPoolmust be a validVkCommandPoolhandlelevelmust be a validVkCommandBufferLevelvaluecommandBufferCountmust be greater than 0
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFOpNext– 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_PRIMARYCOMMAND_BUFFER_LEVEL_SECONDARYcommandBufferCount– 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 classVkCommandBufferAllocateInfo.BufferAn array ofVkCommandBufferAllocateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkCommandBufferAllocateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkCommandBufferAllocateInfocalloc()Returns a newVkCommandBufferAllocateInfoinstance allocated withmemCalloc.static VkCommandBufferAllocateInfo.Buffercalloc(int capacity)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withmemCalloc.static VkCommandBufferAllocateInfocallocStack()Returns a newVkCommandBufferAllocateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandBufferAllocateInfo.BuffercallocStack(int capacity)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandBufferAllocateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandBufferAllocateInfocallocStack(MemoryStack stack)Returns a newVkCommandBufferAllocateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intcommandBufferCount()Returns the value of thecommandBufferCountfield.VkCommandBufferAllocateInfocommandBufferCount(int value)Sets the specified value to thecommandBufferCountfield.longcommandPool()Returns the value of thecommandPoolfield.VkCommandBufferAllocateInfocommandPool(long value)Sets the specified value to thecommandPoolfield.static VkCommandBufferAllocateInfocreate()Returns a newVkCommandBufferAllocateInfoinstance allocated withBufferUtils.static VkCommandBufferAllocateInfo.Buffercreate(int capacity)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withBufferUtils.static VkCommandBufferAllocateInfocreate(long address)Returns a newVkCommandBufferAllocateInfoinstance for the specified memory address ornullif the address isNULL.static VkCommandBufferAllocateInfo.Buffercreate(long address, int capacity)Create aVkCommandBufferAllocateInfo.Bufferinstance at the specified memory.intlevel()Returns the value of thelevelfield.VkCommandBufferAllocateInfolevel(int value)Sets the specified value to thelevelfield.static VkCommandBufferAllocateInfomalloc()Returns a newVkCommandBufferAllocateInfoinstance allocated withmemAlloc.static VkCommandBufferAllocateInfo.Buffermalloc(int capacity)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withmemAlloc.static VkCommandBufferAllocateInfomallocStack()Returns a newVkCommandBufferAllocateInfoinstance allocated on the thread-localMemoryStack.static VkCommandBufferAllocateInfo.BuffermallocStack(int capacity)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkCommandBufferAllocateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkCommandBufferAllocateInfomallocStack(MemoryStack stack)Returns a newVkCommandBufferAllocateInfoinstance allocated on the specifiedMemoryStack.VkCommandBufferAllocateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkCommandBufferAllocateInfopNext(long value)Sets the specified value to thepNextfield.VkCommandBufferAllocateInfoset(int sType, long pNext, long commandPool, int level, int commandBufferCount)Initializes this struct with the specified values.VkCommandBufferAllocateInfoset(VkCommandBufferAllocateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkCommandBufferAllocateInfosType(int value)Sets the specified value to thesTypefield.-
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 aVkCommandBufferAllocateInfoinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
commandPool
public long commandPool()
Returns the value of thecommandPoolfield.
-
level
public int level()
Returns the value of thelevelfield.
-
commandBufferCount
public int commandBufferCount()
Returns the value of thecommandBufferCountfield.
-
sType
public VkCommandBufferAllocateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkCommandBufferAllocateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
commandPool
public VkCommandBufferAllocateInfo commandPool(long value)
Sets the specified value to thecommandPoolfield.
-
level
public VkCommandBufferAllocateInfo level(int value)
Sets the specified value to thelevelfield.
-
commandBufferCount
public VkCommandBufferAllocateInfo commandBufferCount(int value)
Sets the specified value to thecommandBufferCountfield.
-
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 newVkCommandBufferAllocateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkCommandBufferAllocateInfo calloc()
Returns a newVkCommandBufferAllocateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkCommandBufferAllocateInfo create()
Returns a newVkCommandBufferAllocateInfoinstance allocated withBufferUtils.
-
create
public static VkCommandBufferAllocateInfo create(long address)
Returns a newVkCommandBufferAllocateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkCommandBufferAllocateInfo.Buffer malloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkCommandBufferAllocateInfo.Buffer calloc(int capacity)
Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandBufferAllocateInfo.Buffer create(int capacity)
Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandBufferAllocateInfo.Buffer create(long address, int capacity)
Create aVkCommandBufferAllocateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkCommandBufferAllocateInfo mallocStack()
Returns a newVkCommandBufferAllocateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkCommandBufferAllocateInfo callocStack()
Returns a newVkCommandBufferAllocateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkCommandBufferAllocateInfo mallocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkCommandBufferAllocateInfo callocStack(MemoryStack stack)
Returns a newVkCommandBufferAllocateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity)
Returns a newVkCommandBufferAllocateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkCommandBufferAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkCommandBufferAllocateInfo.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-