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
sTypemust beSTRUCTURE_TYPE_COMMAND_POOL_CREATE_INFOpNextmust beNULLflagsmust be a valid combination ofVkCommandPoolCreateFlagBitsvaluesqueueFamilyIndexmust be the index of a queue family available in the calling command'sdeviceparameter
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFOpNext– 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_BITCOMMAND_POOL_CREATE_TRANSIENT_BITqueueFamilyIndex– 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 classVkCommandPoolCreateInfo.BufferAn array ofVkCommandPoolCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkCommandPoolCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkCommandPoolCreateInfocalloc()Returns a newVkCommandPoolCreateInfoinstance allocated withmemCalloc.static VkCommandPoolCreateInfo.Buffercalloc(int capacity)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withmemCalloc.static VkCommandPoolCreateInfocallocStack()Returns a newVkCommandPoolCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandPoolCreateInfo.BuffercallocStack(int capacity)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandPoolCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandPoolCreateInfocallocStack(MemoryStack stack)Returns a newVkCommandPoolCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandPoolCreateInfocreate()Returns a newVkCommandPoolCreateInfoinstance allocated withBufferUtils.static VkCommandPoolCreateInfo.Buffercreate(int capacity)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withBufferUtils.static VkCommandPoolCreateInfocreate(long address)Returns a newVkCommandPoolCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkCommandPoolCreateInfo.Buffercreate(long address, int capacity)Create aVkCommandPoolCreateInfo.Bufferinstance at the specified memory.intflags()Returns the value of theflagsfield.VkCommandPoolCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkCommandPoolCreateInfomalloc()Returns a newVkCommandPoolCreateInfoinstance allocated withmemAlloc.static VkCommandPoolCreateInfo.Buffermalloc(int capacity)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withmemAlloc.static VkCommandPoolCreateInfomallocStack()Returns a newVkCommandPoolCreateInfoinstance allocated on the thread-localMemoryStack.static VkCommandPoolCreateInfo.BuffermallocStack(int capacity)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkCommandPoolCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkCommandPoolCreateInfomallocStack(MemoryStack stack)Returns a newVkCommandPoolCreateInfoinstance allocated on the specifiedMemoryStack.VkCommandPoolCreateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkCommandPoolCreateInfopNext(long value)Sets the specified value to thepNextfield.intqueueFamilyIndex()Returns the value of thequeueFamilyIndexfield.VkCommandPoolCreateInfoqueueFamilyIndex(int value)Sets the specified value to thequeueFamilyIndexfield.VkCommandPoolCreateInfoset(int sType, long pNext, int flags, int queueFamilyIndex)Initializes this struct with the specified values.VkCommandPoolCreateInfoset(VkCommandPoolCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkCommandPoolCreateInfosType(int value)Sets the specified value to thesTypefield.-
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 aVkCommandPoolCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
queueFamilyIndex
public int queueFamilyIndex()
Returns the value of thequeueFamilyIndexfield.
-
sType
public VkCommandPoolCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkCommandPoolCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkCommandPoolCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
queueFamilyIndex
public VkCommandPoolCreateInfo queueFamilyIndex(int value)
Sets the specified value to thequeueFamilyIndexfield.
-
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 newVkCommandPoolCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkCommandPoolCreateInfo calloc()
Returns a newVkCommandPoolCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkCommandPoolCreateInfo create()
Returns a newVkCommandPoolCreateInfoinstance allocated withBufferUtils.
-
create
public static VkCommandPoolCreateInfo create(long address)
Returns a newVkCommandPoolCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkCommandPoolCreateInfo.Buffer malloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkCommandPoolCreateInfo.Buffer calloc(int capacity)
Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandPoolCreateInfo.Buffer create(int capacity)
Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandPoolCreateInfo.Buffer create(long address, int capacity)
Create aVkCommandPoolCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkCommandPoolCreateInfo mallocStack()
Returns a newVkCommandPoolCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkCommandPoolCreateInfo callocStack()
Returns a newVkCommandPoolCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkCommandPoolCreateInfo mallocStack(MemoryStack stack)
Returns a newVkCommandPoolCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkCommandPoolCreateInfo callocStack(MemoryStack stack)
Returns a newVkCommandPoolCreateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkCommandPoolCreateInfo.Buffer callocStack(int capacity)
Returns a newVkCommandPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkCommandPoolCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkCommandPoolCreateInfo.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-