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, NativeResource, Pointer
public class VkCommandPoolCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a command pool should be created.
Valid Usage
sType
must beSTRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkCommandPoolCreateFlagBits
valuesqueueFamilyIndex
must be the index of a queue family available in the calling command'sdevice
parameter
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
pNext
– reserved for use by extensionsflags
– a bitmask indicating usage behavior for the pool and command buffers allocated from it. One or more of:COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT
COMMAND_POOL_CREATE_TRANSIENT_BIT
queueFamilyIndex
– designates a queue family
Layout
struct VkCommandPoolCreateInfo { VkStructureType sType; const void * pNext; VkCommandPoolCreateFlags flags; uint32_t queueFamilyIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkCommandPoolCreateInfo.Buffer
An array ofVkCommandPoolCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and 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, MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandPoolCreateInfo
callocStack(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 ornull
if the address isNULL
.static VkCommandPoolCreateInfo.Buffer
create(long address, int capacity)
Create aVkCommandPoolCreateInfo.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandPoolCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
.VkCommandPoolCreateInfo
nset(long struct)
Unsafe version ofset
.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()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkCommandPoolCreateInfo
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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.
-
nset
public VkCommandPoolCreateInfo nset(long struct)
Unsafe version ofset
.
-
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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkCommandPoolCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandPoolCreateInfo callocStack(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, 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, 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
-
-