VkCommandPoolCreateInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCommandPoolCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created command pool.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
- pNext must be NULL
- flags must be a valid combination of VkCommandPoolCreateFlagBits values
See Also

CreateCommandPool

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkCommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.
- queueFamilyIndex – designates a queue family as described in section Queue Family Properties. All command buffers allocated from this command pool must be submitted on queues from the same queue family.
Layout
```
 struct VkCommandPoolCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkCommandPoolCreateFlags flags;
     uint32_t queueFamilyIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkCommandPoolCreateInfo.Buffer
An array of VkCommandPoolCreateInfo 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`	`VkCommandPoolCreateInfo.Buffer` An array of `VkCommandPoolCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`QUEUEFAMILYINDEX` 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
`VkCommandPoolCreateInfo(java.nio.ByteBuffer container)` Creates a `VkCommandPoolCreateInfo` 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 VkCommandPoolCreateInfo`	`calloc()` Returns a new `VkCommandPoolCreateInfo` instance allocated with `memCalloc`.
`static VkCommandPoolCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkCommandPoolCreateInfo`	`callocStack()` Returns a new `VkCommandPoolCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandPoolCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandPoolCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandPoolCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandPoolCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandPoolCreateInfo`	`create()` Returns a new `VkCommandPoolCreateInfo` instance allocated with `BufferUtils`.
`static VkCommandPoolCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkCommandPoolCreateInfo`	`create(long address)` Returns a new `VkCommandPoolCreateInfo` instance for the specified memory address.
`static VkCommandPoolCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandPoolCreateInfo.Buffer` instance at the specified memory.
`static VkCommandPoolCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCommandPoolCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkCommandPoolCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkCommandPoolCreateInfo`	`malloc()` Returns a new `VkCommandPoolCreateInfo` instance allocated with `memAlloc`.
`static VkCommandPoolCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkCommandPoolCreateInfo`	`mallocStack()` Returns a new `VkCommandPoolCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkCommandPoolCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCommandPoolCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandPoolCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandPoolCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nqueueFamilyIndex(long struct)` Unsafe version of `queueFamilyIndex()`.
`static void`	`nqueueFamilyIndex(long struct, int value)` Unsafe version of `queueFamilyIndex`.
`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.
`VkCommandPoolCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`queueFamilyIndex()` Returns the value of the `queueFamilyIndex` field.
`VkCommandPoolCreateInfo`	`queueFamilyIndex(int value)` Sets the specified value to the `queueFamilyIndex` field.
`VkCommandPoolCreateInfo`	`set(int sType, long pNext, int flags, int queueFamilyIndex)` Initializes this struct with the specified values.
`VkCommandPoolCreateInfo`	`set(VkCommandPoolCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkCommandPoolCreateInfo`	`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.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - QUEUEFAMILYINDEX
```
public static final int QUEUEFAMILYINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkCommandPoolCreateInfo
```
public VkCommandPoolCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkCommandPoolCreateInfo 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.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - queueFamilyIndex
```
public int queueFamilyIndex()
```
    Returns the value of the queueFamilyIndex field.
  - sType
```
public VkCommandPoolCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkCommandPoolCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkCommandPoolCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - queueFamilyIndex
```
public VkCommandPoolCreateInfo queueFamilyIndex(int value)
```
    Sets the specified value to the queueFamilyIndex field.
  - set
```
public VkCommandPoolCreateInfo set(int sType,
                                   long pNext,
                                   int flags,
                                   int queueFamilyIndex)
```
    Initializes this struct with the specified values.
  - set
```
public VkCommandPoolCreateInfo set(VkCommandPoolCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkCommandPoolCreateInfo malloc()
```
    Returns a new VkCommandPoolCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCommandPoolCreateInfo calloc()
```
    Returns a new VkCommandPoolCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCommandPoolCreateInfo create()
```
    Returns a new VkCommandPoolCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkCommandPoolCreateInfo create(long address)
```
    Returns a new VkCommandPoolCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCommandPoolCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCommandPoolCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCommandPoolCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandPoolCreateInfo.Buffer create(int capacity)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandPoolCreateInfo.Buffer create(long address,
                                                    int capacity)
```
    Create a VkCommandPoolCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCommandPoolCreateInfo.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkCommandPoolCreateInfo mallocStack()
```
    Returns a new VkCommandPoolCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCommandPoolCreateInfo callocStack()
```
    Returns a new VkCommandPoolCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCommandPoolCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCommandPoolCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandPoolCreateInfo.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().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nqueueFamilyIndex
```
public static int nqueueFamilyIndex(long struct)
```
    Unsafe version of queueFamilyIndex().
  - 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.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nqueueFamilyIndex
```
public static void nqueueFamilyIndex(long struct,
                                     int value)
```
    Unsafe version of queueFamilyIndex.

Class VkCommandPoolCreateInfo

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

FLAGS

QUEUEFAMILYINDEX

Constructor Detail

VkCommandPoolCreateInfo

Method Detail

sizeof

sType

pNext

flags

queueFamilyIndex

sType

pNext

flags

queueFamilyIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nqueueFamilyIndex

nsType

npNext

nflags

nqueueFamilyIndex