Package org.lwjgl.vulkan

Class VkCommandPoolCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCommandPoolCreateInfo>

org.lwjgl.vulkan.VkCommandPoolCreateInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkCommandPoolCreateInfo
extends org.lwjgl.system.Struct<VkCommandPoolCreateInfo>
implements org.lwjgl.system.NativeResource

Structure specifying parameters of a newly created command pool.

Valid Usage

• If the protectedMemory feature is not enabled, the COMMAND_POOL_CREATE_PROTECTED_BIT bit of flags must not be set

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

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCommandPoolCreateInfo.Buffer	An array of VkCommandPoolCreateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	QUEUEFAMILYINDEX	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkCommandPoolCreateInfo(ByteBuffer container)	Creates a VkCommandPoolCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(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	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCommandPoolCreateInfo	callocStack()	Deprecated.
static VkCommandPoolCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkCommandPoolCreateInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkCommandPoolCreateInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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 @Nullable VkCommandPoolCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCommandPoolCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkCommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.
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.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkCommandPoolCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack.
static VkCommandPoolCreateInfo	mallocStack()	Deprecated.
static VkCommandPoolCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkCommandPoolCreateInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkCommandPoolCreateInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()	NULL or a pointer to a structure extending this structure.
VkCommandPoolCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
int	queueFamilyIndex()	designates a queue family as described in section Queue Family Properties.
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()	a VkStructureType value identifying this structure.
VkCommandPoolCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkCommandPoolCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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 Details

VkCommandPoolCreateInfo

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkCommandPoolCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

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

queueFamilyIndex

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.

sType

public VkCommandPoolCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCommandPoolCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO 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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkCommandPoolCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkCommandPoolCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandPoolCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandPoolCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkCommandPoolCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCommandPoolCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCommandPoolCreateInfo calloc(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

malloc

public static VkCommandPoolCreateInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCommandPoolCreateInfo.Buffer calloc(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:

capacity - the buffer capacity

stack - the stack from which to allocate

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.