Package org.lwjgl.vulkan
Class VkCommandPoolCreateInfo
- 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 beSTRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkCommandPoolCreateFlagBits
values
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– a bitmask ofVkCommandPoolCreateFlagBits
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 Description static class
VkCommandPoolCreateInfo.Buffer
An array ofVkCommandPoolCreateInfo
structs.
-
Constructor Summary
Constructors Constructor Description VkCommandPoolCreateInfo(java.nio.ByteBuffer container)
Creates aVkCommandPoolCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkCommandPoolCreateInfo
calloc()
Returns a newVkCommandPoolCreateInfo
instance allocated withmemCalloc
.static VkCommandPoolCreateInfo.Buffer
calloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withmemCalloc
.static VkCommandPoolCreateInfo
callocStack()
Returns a newVkCommandPoolCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandPoolCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandPoolCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandPoolCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandPoolCreateInfo
create()
Returns a newVkCommandPoolCreateInfo
instance allocated withBufferUtils
.static VkCommandPoolCreateInfo.Buffer
create(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withBufferUtils
.static VkCommandPoolCreateInfo
create(long address)
Returns a newVkCommandPoolCreateInfo
instance for the specified memory address.static VkCommandPoolCreateInfo.Buffer
create(long address, int capacity)
Create aVkCommandPoolCreateInfo.Buffer
instance at the specified memory.static VkCommandPoolCreateInfo
createSafe(long address)
static VkCommandPoolCreateInfo.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkCommandPoolCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkCommandPoolCreateInfo
malloc()
Returns a newVkCommandPoolCreateInfo
instance allocated withmemAlloc
.static VkCommandPoolCreateInfo.Buffer
malloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withmemAlloc
.static VkCommandPoolCreateInfo
mallocStack()
Returns a newVkCommandPoolCreateInfo
instance allocated on the thread-localMemoryStack
.static VkCommandPoolCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkCommandPoolCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandPoolCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nqueueFamilyIndex(long struct)
Unsafe version ofqueueFamilyIndex()
.static void
nqueueFamilyIndex(long struct, int value)
Unsafe version ofqueueFamilyIndex
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkCommandPoolCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.int
queueFamilyIndex()
Returns the value of thequeueFamilyIndex
field.VkCommandPoolCreateInfo
queueFamilyIndex(int value)
Sets the specified value to thequeueFamilyIndex
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 thesType
field.VkCommandPoolCreateInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkCommandPoolCreateInfo
public VkCommandPoolCreateInfo(java.nio.ByteBuffer container)
Creates aVkCommandPoolCreateInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
queueFamilyIndex
public int queueFamilyIndex()
Returns the value of thequeueFamilyIndex
field.
-
sType
public VkCommandPoolCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkCommandPoolCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkCommandPoolCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
queueFamilyIndex
public VkCommandPoolCreateInfo queueFamilyIndex(int value)
Sets the specified value to thequeueFamilyIndex
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 newVkCommandPoolCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkCommandPoolCreateInfo calloc()
Returns a newVkCommandPoolCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkCommandPoolCreateInfo create()
Returns a newVkCommandPoolCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkCommandPoolCreateInfo create(long address)
Returns a newVkCommandPoolCreateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkCommandPoolCreateInfo createSafe(long address)
-
malloc
public static VkCommandPoolCreateInfo.Buffer malloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkCommandPoolCreateInfo.Buffer calloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandPoolCreateInfo.Buffer create(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandPoolCreateInfo.Buffer create(long address, int capacity)
Create aVkCommandPoolCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkCommandPoolCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkCommandPoolCreateInfo mallocStack()
Returns a newVkCommandPoolCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkCommandPoolCreateInfo callocStack()
Returns a newVkCommandPoolCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkCommandPoolCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandPoolCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
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 newVkCommandPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
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 newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
nqueueFamilyIndex
public static int nqueueFamilyIndex(long struct)
Unsafe version ofqueueFamilyIndex()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nflags
public static void nflags(long struct, int value)
Unsafe version offlags
.
-
nqueueFamilyIndex
public static void nqueueFamilyIndex(long struct, int value)
Unsafe version ofqueueFamilyIndex
.
-
-