Package org.lwjgl.vulkan
Class VkMemoryAllocateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkMemoryAllocateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkMemoryAllocateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes parameters of a memory allocation.
Valid Usage
sType
must beSTRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
pNext
must beNULL
allocationSize
must be less than or equal to the amount of memory available to theVkMemoryHeap
specified bymemoryTypeIndex
and the calling command'sVkDevice
allocationSize
must be greater than 0
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
pNext
– reserved for use by extensionsallocationSize
– the size of the allocation in bytesmemoryTypeIndex
– the memory type index, which selects the properties of the memory to be allocated, as well as the heap the memory will come from
Layout
struct VkMemoryAllocateInfo { VkStructureType sType; const void * pNext; VkDeviceSize allocationSize; uint32_t memoryTypeIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkMemoryAllocateInfo.Buffer
An array ofVkMemoryAllocateInfo
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 VkMemoryAllocateInfo(java.nio.ByteBuffer container)
Creates aVkMemoryAllocateInfo
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 long
allocationSize()
Returns the value of theallocationSize
field.VkMemoryAllocateInfo
allocationSize(long value)
Sets the specified value to theallocationSize
field.static VkMemoryAllocateInfo
calloc()
Returns a newVkMemoryAllocateInfo
instance allocated withmemCalloc
.static VkMemoryAllocateInfo.Buffer
calloc(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withmemCalloc
.static VkMemoryAllocateInfo
callocStack()
Returns a newVkMemoryAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryAllocateInfo.Buffer
callocStack(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryAllocateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryAllocateInfo
callocStack(MemoryStack stack)
Returns a newVkMemoryAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryAllocateInfo
create()
Returns a newVkMemoryAllocateInfo
instance allocated withBufferUtils
.static VkMemoryAllocateInfo.Buffer
create(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withBufferUtils
.static VkMemoryAllocateInfo
create(long address)
Returns a newVkMemoryAllocateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkMemoryAllocateInfo.Buffer
create(long address, int capacity)
Create aVkMemoryAllocateInfo.Buffer
instance at the specified memory.static VkMemoryAllocateInfo
malloc()
Returns a newVkMemoryAllocateInfo
instance allocated withmemAlloc
.static VkMemoryAllocateInfo.Buffer
malloc(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withmemAlloc
.static VkMemoryAllocateInfo
mallocStack()
Returns a newVkMemoryAllocateInfo
instance allocated on the thread-localMemoryStack
.static VkMemoryAllocateInfo.Buffer
mallocStack(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkMemoryAllocateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkMemoryAllocateInfo
mallocStack(MemoryStack stack)
Returns a newVkMemoryAllocateInfo
instance allocated on the specifiedMemoryStack
.int
memoryTypeIndex()
Returns the value of thememoryTypeIndex
field.VkMemoryAllocateInfo
memoryTypeIndex(int value)
Sets the specified value to thememoryTypeIndex
field.VkMemoryAllocateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkMemoryAllocateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkMemoryAllocateInfo
set(int sType, long pNext, long allocationSize, int memoryTypeIndex)
Initializes this struct with the specified values.VkMemoryAllocateInfo
set(VkMemoryAllocateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkMemoryAllocateInfo
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
-
VkMemoryAllocateInfo
public VkMemoryAllocateInfo(java.nio.ByteBuffer container)
Creates aVkMemoryAllocateInfo
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.
-
allocationSize
public long allocationSize()
Returns the value of theallocationSize
field.
-
memoryTypeIndex
public int memoryTypeIndex()
Returns the value of thememoryTypeIndex
field.
-
sType
public VkMemoryAllocateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkMemoryAllocateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
allocationSize
public VkMemoryAllocateInfo allocationSize(long value)
Sets the specified value to theallocationSize
field.
-
memoryTypeIndex
public VkMemoryAllocateInfo memoryTypeIndex(int value)
Sets the specified value to thememoryTypeIndex
field.
-
set
public VkMemoryAllocateInfo set(int sType, long pNext, long allocationSize, int memoryTypeIndex)
Initializes this struct with the specified values.
-
nset
public VkMemoryAllocateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkMemoryAllocateInfo set(VkMemoryAllocateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkMemoryAllocateInfo malloc()
Returns a newVkMemoryAllocateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkMemoryAllocateInfo calloc()
Returns a newVkMemoryAllocateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkMemoryAllocateInfo create()
Returns a newVkMemoryAllocateInfo
instance allocated withBufferUtils
.
-
create
public static VkMemoryAllocateInfo create(long address)
Returns a newVkMemoryAllocateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkMemoryAllocateInfo.Buffer malloc(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkMemoryAllocateInfo.Buffer calloc(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryAllocateInfo.Buffer create(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryAllocateInfo.Buffer create(long address, int capacity)
Create aVkMemoryAllocateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkMemoryAllocateInfo mallocStack()
Returns a newVkMemoryAllocateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkMemoryAllocateInfo callocStack()
Returns a newVkMemoryAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkMemoryAllocateInfo mallocStack(MemoryStack stack)
Returns a newVkMemoryAllocateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkMemoryAllocateInfo callocStack(MemoryStack stack)
Returns a newVkMemoryAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkMemoryAllocateInfo.Buffer mallocStack(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkMemoryAllocateInfo.Buffer callocStack(int capacity)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkMemoryAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkMemoryAllocateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-