VkCommandBufferAllocateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkCommandBufferAllocateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCommandBufferAllocateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying the allocation parameters for command buffer object.
Valid Usage
- commandBufferCount must be greater than 0
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
- pNext must be NULL
- commandPool must be a valid VkCommandPool handle
- level must be a valid VkCommandBufferLevel value
See Also

AllocateCommandBuffers

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- commandPool – the command pool from which the command buffers are allocated.
- level – a VkCommandBufferLevel value specifying the command buffer level.
- commandBufferCount – the number of command buffers to allocate from the pool.
Layout
```
 struct VkCommandBufferAllocateInfo {
     VkStructureType sType;
     void const * 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 of VkCommandBufferAllocateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkCommandBufferAllocateInfo.Buffer` An array of `VkCommandBufferAllocateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COMMANDBUFFERCOUNT` The struct member offsets.
`static int`	`COMMANDPOOL` The struct member offsets.
`static int`	`LEVEL` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkCommandBufferAllocateInfo(java.nio.ByteBuffer container)` Creates a `VkCommandBufferAllocateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkCommandBufferAllocateInfo`	`calloc()` Returns a new `VkCommandBufferAllocateInfo` instance allocated with `memCalloc`.
`static VkCommandBufferAllocateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated with `memCalloc`.
`static VkCommandBufferAllocateInfo`	`callocStack()` Returns a new `VkCommandBufferAllocateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferAllocateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferAllocateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferAllocateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferAllocateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`commandBufferCount()` Returns the value of the `commandBufferCount` field.
`VkCommandBufferAllocateInfo`	`commandBufferCount(int value)` Sets the specified value to the `commandBufferCount` field.
`long`	`commandPool()` Returns the value of the `commandPool` field.
`VkCommandBufferAllocateInfo`	`commandPool(long value)` Sets the specified value to the `commandPool` field.
`static VkCommandBufferAllocateInfo`	`create()` Returns a new `VkCommandBufferAllocateInfo` instance allocated with `BufferUtils`.
`static VkCommandBufferAllocateInfo.Buffer`	`create(int capacity)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkCommandBufferAllocateInfo`	`create(long address)` Returns a new `VkCommandBufferAllocateInfo` instance for the specified memory address.
`static VkCommandBufferAllocateInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandBufferAllocateInfo.Buffer` instance at the specified memory.
`static VkCommandBufferAllocateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCommandBufferAllocateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`level()` Returns the value of the `level` field.
`VkCommandBufferAllocateInfo`	`level(int value)` Sets the specified value to the `level` field.
`static VkCommandBufferAllocateInfo`	`malloc()` Returns a new `VkCommandBufferAllocateInfo` instance allocated with `memAlloc`.
`static VkCommandBufferAllocateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated with `memAlloc`.
`static VkCommandBufferAllocateInfo`	`mallocStack()` Returns a new `VkCommandBufferAllocateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferAllocateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferAllocateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferAllocateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferAllocateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferAllocateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ncommandBufferCount(long struct)` Unsafe version of `commandBufferCount()`.
`static void`	`ncommandBufferCount(long struct, int value)` Unsafe version of `commandBufferCount`.
`static long`	`ncommandPool(long struct)` Unsafe version of `commandPool()`.
`static void`	`ncommandPool(long struct, long value)` Unsafe version of `commandPool`.
`static int`	`nlevel(long struct)` Unsafe version of `level()`.
`static void`	`nlevel(long struct, int value)` Unsafe version of `level`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkCommandBufferAllocateInfo`	`pNext(long value)` Sets the specified value to the `pNext` 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()`
`int`	`sType()` Returns the value of the `sType` field.
`VkCommandBufferAllocateInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - COMMANDPOOL
```
public static final int COMMANDPOOL
```
    The struct member offsets.
  - LEVEL
```
public static final int LEVEL
```
    The struct member offsets.
  - COMMANDBUFFERCOUNT
```
public static final int COMMANDBUFFERCOUNT
```
    The struct member offsets.
- Constructor Detail
  - VkCommandBufferAllocateInfo
```
public VkCommandBufferAllocateInfo(java.nio.ByteBuffer container)
```
    Creates a VkCommandBufferAllocateInfo 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - commandPool
```
public long commandPool()
```
    Returns the value of the commandPool field.
  - level
```
public int level()
```
    Returns the value of the level field.
  - commandBufferCount
```
public int commandBufferCount()
```
    Returns the value of the commandBufferCount field.
  - sType
```
public VkCommandBufferAllocateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkCommandBufferAllocateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - commandPool
```
public VkCommandBufferAllocateInfo commandPool(long value)
```
    Sets the specified value to the commandPool field.
  - level
```
public VkCommandBufferAllocateInfo level(int value)
```
    Sets the specified value to the level field.
  - commandBufferCount
```
public VkCommandBufferAllocateInfo commandBufferCount(int value)
```
    Sets the specified value to the commandBufferCount field.
  - set
```
public VkCommandBufferAllocateInfo set(int sType,
                                       long pNext,
                                       long commandPool,
                                       int level,
                                       int commandBufferCount)
```
    Initializes this struct with the specified values.
  - 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 new VkCommandBufferAllocateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCommandBufferAllocateInfo calloc()
```
    Returns a new VkCommandBufferAllocateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCommandBufferAllocateInfo create()
```
    Returns a new VkCommandBufferAllocateInfo instance allocated with BufferUtils.
  - create
```
public static VkCommandBufferAllocateInfo create(long address)
```
    Returns a new VkCommandBufferAllocateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCommandBufferAllocateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCommandBufferAllocateInfo.Buffer malloc(int capacity)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCommandBufferAllocateInfo.Buffer calloc(int capacity)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferAllocateInfo.Buffer create(int capacity)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferAllocateInfo.Buffer create(long address,
                                                        int capacity)
```
    Create a VkCommandBufferAllocateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCommandBufferAllocateInfo.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkCommandBufferAllocateInfo mallocStack()
```
    Returns a new VkCommandBufferAllocateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCommandBufferAllocateInfo callocStack()
```
    Returns a new VkCommandBufferAllocateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCommandBufferAllocateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferAllocateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCommandBufferAllocateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferAllocateInfo instance allocated on the specified MemoryStack 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 new VkCommandBufferAllocateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCommandBufferAllocateInfo.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferAllocateInfo.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - ncommandPool
```
public static long ncommandPool(long struct)
```
    Unsafe version of commandPool().
  - nlevel
```
public static int nlevel(long struct)
```
    Unsafe version of level().
  - ncommandBufferCount
```
public static int ncommandBufferCount(long struct)
```
    Unsafe version of commandBufferCount().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - ncommandPool
```
public static void ncommandPool(long struct,
                                long value)
```
    Unsafe version of commandPool.
  - nlevel
```
public static void nlevel(long struct,
                          int value)
```
    Unsafe version of level.
  - ncommandBufferCount
```
public static void ncommandBufferCount(long struct,
                                       int value)
```
    Unsafe version of commandBufferCount.

Class VkCommandBufferAllocateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

COMMANDPOOL

LEVEL

COMMANDBUFFERCOUNT

Constructor Detail

VkCommandBufferAllocateInfo

Method Detail

sizeof

sType

pNext

commandPool

level

commandBufferCount

sType

pNext

commandPool

level

commandBufferCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ncommandPool

nlevel

ncommandBufferCount

nsType

npNext

ncommandPool

nlevel

ncommandBufferCount