Package org.lwjgl.vulkan
Class VkMemoryRequirements
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkMemoryRequirements
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkMemoryRequirements extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about the memory requirements of an object.
Member documentation
size
– the size, in bytes, of the memory allocation required for the resourcealignment
– the alignment, in bytes, of the offset within the allocation required for the resourcememoryTypeBits
– a bitfield and contains one bit set for every supported memory type for the resource
Layout
struct VkMemoryRequirements { VkDeviceSize size; VkDeviceSize alignment; uint32_t memoryTypeBits; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkMemoryRequirements.Buffer
An array ofVkMemoryRequirements
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 VkMemoryRequirements(java.nio.ByteBuffer container)
Creates aVkMemoryRequirements
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
alignment()
Returns the value of thealignment
field.static VkMemoryRequirements
calloc()
Returns a newVkMemoryRequirements
instance allocated withmemCalloc
.static VkMemoryRequirements.Buffer
calloc(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withmemCalloc
.static VkMemoryRequirements
callocStack()
Returns a newVkMemoryRequirements
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryRequirements.Buffer
callocStack(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryRequirements.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryRequirements
callocStack(MemoryStack stack)
Returns a newVkMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryRequirements
create()
Returns a newVkMemoryRequirements
instance allocated withBufferUtils
.static VkMemoryRequirements.Buffer
create(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withBufferUtils
.static VkMemoryRequirements
create(long address)
Returns a newVkMemoryRequirements
instance for the specified memory address ornull
if the address isNULL
.static VkMemoryRequirements.Buffer
create(long address, int capacity)
Create aVkMemoryRequirements.Buffer
instance at the specified memory.static VkMemoryRequirements
malloc()
Returns a newVkMemoryRequirements
instance allocated withmemAlloc
.static VkMemoryRequirements.Buffer
malloc(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withmemAlloc
.static VkMemoryRequirements
mallocStack()
Returns a newVkMemoryRequirements
instance allocated on the thread-localMemoryStack
.static VkMemoryRequirements.Buffer
mallocStack(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
.static VkMemoryRequirements.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.static VkMemoryRequirements
mallocStack(MemoryStack stack)
Returns a newVkMemoryRequirements
instance allocated on the specifiedMemoryStack
.int
memoryTypeBits()
Returns the value of thememoryTypeBits
field.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
-
VkMemoryRequirements
public VkMemoryRequirements(java.nio.ByteBuffer container)
Creates aVkMemoryRequirements
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.
-
alignment
public long alignment()
Returns the value of thealignment
field.
-
memoryTypeBits
public int memoryTypeBits()
Returns the value of thememoryTypeBits
field.
-
malloc
public static VkMemoryRequirements malloc()
Returns a newVkMemoryRequirements
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkMemoryRequirements calloc()
Returns a newVkMemoryRequirements
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkMemoryRequirements create()
Returns a newVkMemoryRequirements
instance allocated withBufferUtils
.
-
create
public static VkMemoryRequirements create(long address)
Returns a newVkMemoryRequirements
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkMemoryRequirements.Buffer malloc(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkMemoryRequirements.Buffer calloc(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryRequirements.Buffer create(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryRequirements.Buffer create(long address, int capacity)
Create aVkMemoryRequirements.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkMemoryRequirements mallocStack()
Returns a newVkMemoryRequirements
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkMemoryRequirements callocStack()
Returns a newVkMemoryRequirements
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkMemoryRequirements mallocStack(MemoryStack stack)
Returns a newVkMemoryRequirements
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkMemoryRequirements callocStack(MemoryStack stack)
Returns a newVkMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkMemoryRequirements.Buffer mallocStack(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkMemoryRequirements.Buffer callocStack(int capacity)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkMemoryRequirements.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkMemoryRequirements.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-