Package org.lwjgl.vulkan
Class VkMemoryHeap
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkMemoryHeap
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkMemoryHeap extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about a memory heap.
Member documentation
size
– the total memory size in bytes in the heapflags
– a bitmask ofVkMemoryHeapFlagBits
attribute flags for the heap. One or more of:MEMORY_HEAP_DEVICE_LOCAL_BIT
Layout
struct VkMemoryHeap { VkDeviceSize size; VkMemoryHeapFlags flags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkMemoryHeap.Buffer
An array ofVkMemoryHeap
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 VkMemoryHeap(java.nio.ByteBuffer container)
Creates aVkMemoryHeap
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 VkMemoryHeap
calloc()
Returns a newVkMemoryHeap
instance allocated withmemCalloc
.static VkMemoryHeap.Buffer
calloc(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withmemCalloc
.static VkMemoryHeap
callocStack()
Returns a newVkMemoryHeap
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryHeap.Buffer
callocStack(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryHeap.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryHeap.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryHeap
callocStack(MemoryStack stack)
Returns a newVkMemoryHeap
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryHeap
create()
Returns a newVkMemoryHeap
instance allocated withBufferUtils
.static VkMemoryHeap.Buffer
create(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withBufferUtils
.static VkMemoryHeap
create(long address)
Returns a newVkMemoryHeap
instance for the specified memory address ornull
if the address isNULL
.static VkMemoryHeap.Buffer
create(long address, int capacity)
Create aVkMemoryHeap.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.static VkMemoryHeap
malloc()
Returns a newVkMemoryHeap
instance allocated withmemAlloc
.static VkMemoryHeap.Buffer
malloc(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withmemAlloc
.static VkMemoryHeap
mallocStack()
Returns a newVkMemoryHeap
instance allocated on the thread-localMemoryStack
.static VkMemoryHeap.Buffer
mallocStack(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated on the thread-localMemoryStack
.static VkMemoryHeap.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryHeap.Buffer
instance allocated on the specifiedMemoryStack
.static VkMemoryHeap
mallocStack(MemoryStack stack)
Returns a newVkMemoryHeap
instance allocated on the specifiedMemoryStack
.long
size()
Returns the value of thesize
field.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkMemoryHeap
public VkMemoryHeap(java.nio.ByteBuffer container)
Creates aVkMemoryHeap
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)
.
-
size
public long size()
Returns the value of thesize
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
malloc
public static VkMemoryHeap malloc()
Returns a newVkMemoryHeap
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkMemoryHeap calloc()
Returns a newVkMemoryHeap
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkMemoryHeap create()
Returns a newVkMemoryHeap
instance allocated withBufferUtils
.
-
create
public static VkMemoryHeap create(long address)
Returns a newVkMemoryHeap
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkMemoryHeap.Buffer malloc(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkMemoryHeap.Buffer calloc(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryHeap.Buffer create(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryHeap.Buffer create(long address, int capacity)
Create aVkMemoryHeap.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkMemoryHeap mallocStack()
Returns a newVkMemoryHeap
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkMemoryHeap callocStack()
Returns a newVkMemoryHeap
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkMemoryHeap mallocStack(MemoryStack stack)
Returns a newVkMemoryHeap
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkMemoryHeap callocStack(MemoryStack stack)
Returns a newVkMemoryHeap
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkMemoryHeap.Buffer mallocStack(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkMemoryHeap.Buffer callocStack(int capacity)
Returns a newVkMemoryHeap.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkMemoryHeap.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryHeap.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkMemoryHeap.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryHeap.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-