Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCommandPoolCreateInfo

extends Struct<VkCommandPoolCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying parameters of a newly created command pool.
Valid Usage
Valid Usage (Implicit)
See Also

CreateCommandPool

Layout


struct VkCommandPoolCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkCommandPoolCreateFlags flags;
    uint32_t queueFamilyIndex;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkCommandPoolCreateInfo.Buffer

An array of VkCommandPoolCreateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
QUEUEFAMILYINDEX

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkCommandPoolCreateInfo(long address, ByteBuffer container)

public
VkCommandPoolCreateInfo(ByteBuffer container)

Creates a VkCommandPoolCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkCommandPoolCreateInfo
calloc()

Returns a new VkCommandPoolCreateInfo instance allocated with memCalloc.

public static VkCommandPoolCreateInfo.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memCalloc.

public static VkCommandPoolCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkCommandPoolCreateInfo.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkCommandPoolCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkCommandPoolCreateInfo
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCommandPoolCreateInfo
create()

Returns a new VkCommandPoolCreateInfo instance allocated with BufferUtils.

public static VkCommandPoolCreateInfo
create(long address)

Returns a new VkCommandPoolCreateInfo instance for the specified memory address.

public static VkCommandPoolCreateInfo.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with BufferUtils.

public static VkCommandPoolCreateInfo.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkCommandPoolCreateInfo.Buffer instance at the specified memory.

public static VkCommandPoolCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkCommandPoolCreateInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkCommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.

public VkCommandPoolCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VkCommandPoolCreateInfo
malloc()

Returns a new VkCommandPoolCreateInfo instance allocated with memAlloc.

public static VkCommandPoolCreateInfo.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memAlloc.

public static VkCommandPoolCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack.

public static VkCommandPoolCreateInfo.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.

public static VkCommandPoolCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCommandPoolCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

public static void
nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCommandPoolCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public int
queueFamilyIndex()

designates a queue family as described in section Queue Family Properties.

public VkCommandPoolCreateInfo
queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

public VkCommandPoolCreateInfo
set(int sType, long pNext, int flags, int queueFamilyIndex)

Initializes this struct with the specified values.

public VkCommandPoolCreateInfo

Returns:

this struct
set(VkCommandPoolCreateInfo
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkCommandPoolCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkCommandPoolCreateInfo
sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

QUEUEFAMILYINDEXback to summary
public static final int QUEUEFAMILYINDEX

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkCommandPoolCreateInfoback to summary
protected VkCommandPoolCreateInfo(long address, ByteBuffer container)
VkCommandPoolCreateInfoback to summary
public VkCommandPoolCreateInfo(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

callocback to summary
public static VkCommandPoolCreateInfo calloc()

Returns a new VkCommandPoolCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkCommandPoolCreateInfo.Buffer calloc(int capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCommandPoolCreateInfo calloc(MemoryStack stack)

Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkCommandPoolCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkCommandPoolCreateInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkCommandPoolCreateInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkCommandPoolCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkCommandPoolCreateInfo create()

Returns a new VkCommandPoolCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkCommandPoolCreateInfo create(long address)

Returns a new VkCommandPoolCreateInfo instance for the specified memory address.

createback to summary
public static VkCommandPoolCreateInfo.Buffer create(int capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkCommandPoolCreateInfo.Buffer create(long address, int capacity)

Create a VkCommandPoolCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCommandPoolCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCommandPoolCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkCommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.

Annotations
@NativeType:VkCommandPoolCreateFlags
flagsback to summary
public VkCommandPoolCreateInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkCommandPoolCreateInfo malloc()

Returns a new VkCommandPoolCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkCommandPoolCreateInfo.Buffer malloc(int capacity)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCommandPoolCreateInfo malloc(MemoryStack stack)

Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkCommandPoolCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkCommandPoolCreateInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkCommandPoolCreateInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nqueueFamilyIndexback to summary
public static int nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex.

nqueueFamilyIndexback to summary
public static void nqueueFamilyIndex(long struct, int value)

Unsafe version of queueFamilyIndex.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandPoolCreateInfo pNext(long value)

Sets the specified value to the pNext field.

queueFamilyIndexback to summary
public int 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.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public VkCommandPoolCreateInfo queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex field.

setback to summary
public VkCommandPoolCreateInfo set(int sType, long pNext, int flags, int queueFamilyIndex)

Initializes this struct with the specified values.

setback to summary
public VkCommandPoolCreateInfo set(VkCommandPoolCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkCommandPoolCreateInfo

the source struct

Returns:VkCommandPoolCreateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandPoolCreateInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkCommandPoolCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCommandPoolCreateInfo.Buffer

extends StructBuffer<VkCommandPoolCreateInfo, VkCommandPoolCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkCommandPoolCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkCommandPoolCreateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCommandPoolCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkCommandPoolCreateInfo#flags field.
flags()

public VkCommandPoolCreateInfo.Buffer
flags(int value)

Sets the specified value to the VkCommandPoolCreateInfo#flags field.

protected VkCommandPoolCreateInfo
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkCommandPoolCreateInfo#pNext field.
pNext()

public VkCommandPoolCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkCommandPoolCreateInfo#pNext field.

public int

Returns:

the value of the VkCommandPoolCreateInfo#queueFamilyIndex field.
queueFamilyIndex()

public VkCommandPoolCreateInfo.Buffer
queueFamilyIndex(int value)

Sets the specified value to the VkCommandPoolCreateInfo#queueFamilyIndex field.

protected VkCommandPoolCreateInfo.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkCommandPoolCreateInfo#sType field.
sType()

public VkCommandPoolCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkCommandPoolCreateInfo#sType field.

public VkCommandPoolCreateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO value to the VkCommandPoolCreateInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCommandPoolCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCommandPoolCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCommandPoolCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public int flags()
Returns:int

the value of the VkCommandPoolCreateInfo#flags field.

Annotations
@NativeType:VkCommandPoolCreateFlags
flagsback to summary
public VkCommandPoolCreateInfo.Buffer flags(int value)

Sets the specified value to the VkCommandPoolCreateInfo#flags field.

getElementFactoryback to summary
protected VkCommandPoolCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkCommandPoolCreateInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandPoolCreateInfo.Buffer pNext(long value)

Sets the specified value to the VkCommandPoolCreateInfo#pNext field.

queueFamilyIndexback to summary
public int queueFamilyIndex()
Returns:int

the value of the VkCommandPoolCreateInfo#queueFamilyIndex field.

Annotations
@NativeType:uint32_t
queueFamilyIndexback to summary
public VkCommandPoolCreateInfo.Buffer queueFamilyIndex(int value)

Sets the specified value to the VkCommandPoolCreateInfo#queueFamilyIndex field.

selfback to summary
protected VkCommandPoolCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkCommandPoolCreateInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandPoolCreateInfo.Buffer sType(int value)

Sets the specified value to the VkCommandPoolCreateInfo#sType field.

sType$Defaultback to summary
public VkCommandPoolCreateInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO value to the VkCommandPoolCreateInfo#sType field.