Package org.lwjgl.vulkan
Class VkMemoryType
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkMemoryType
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkMemoryType extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about a memory type.
Member documentation
propertyFlags
– a bitmask ofVkMemoryPropertyFlagBits
properties for this memory type. One or more of:MEMORY_PROPERTY_DEVICE_LOCAL_BIT
MEMORY_PROPERTY_HOST_CACHED_BIT
MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT
MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT
heapIndex
– describes which memory heap this memory type corresponds to, and must be less thanmemoryHeapCount
from theVkPhysicalDeviceMemoryProperties
structure
Layout
struct VkMemoryType { VkMemoryPropertyFlags propertyFlags; uint32_t heapIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkMemoryType.Buffer
An array ofVkMemoryType
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 VkMemoryType(java.nio.ByteBuffer container)
Creates aVkMemoryType
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 VkMemoryType
calloc()
Returns a newVkMemoryType
instance allocated withmemCalloc
.static VkMemoryType.Buffer
calloc(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withmemCalloc
.static VkMemoryType
callocStack()
Returns a newVkMemoryType
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryType.Buffer
callocStack(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkMemoryType.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryType.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryType
callocStack(MemoryStack stack)
Returns a newVkMemoryType
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMemoryType
create()
Returns a newVkMemoryType
instance allocated withBufferUtils
.static VkMemoryType.Buffer
create(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withBufferUtils
.static VkMemoryType
create(long address)
Returns a newVkMemoryType
instance for the specified memory address ornull
if the address isNULL
.static VkMemoryType.Buffer
create(long address, int capacity)
Create aVkMemoryType.Buffer
instance at the specified memory.int
heapIndex()
Returns the value of theheapIndex
field.static VkMemoryType
malloc()
Returns a newVkMemoryType
instance allocated withmemAlloc
.static VkMemoryType.Buffer
malloc(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withmemAlloc
.static VkMemoryType
mallocStack()
Returns a newVkMemoryType
instance allocated on the thread-localMemoryStack
.static VkMemoryType.Buffer
mallocStack(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated on the thread-localMemoryStack
.static VkMemoryType.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryType.Buffer
instance allocated on the specifiedMemoryStack
.static VkMemoryType
mallocStack(MemoryStack stack)
Returns a newVkMemoryType
instance allocated on the specifiedMemoryStack
.int
propertyFlags()
Returns the value of thepropertyFlags
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
-
VkMemoryType
public VkMemoryType(java.nio.ByteBuffer container)
Creates aVkMemoryType
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)
.
-
propertyFlags
public int propertyFlags()
Returns the value of thepropertyFlags
field.
-
heapIndex
public int heapIndex()
Returns the value of theheapIndex
field.
-
malloc
public static VkMemoryType malloc()
Returns a newVkMemoryType
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkMemoryType calloc()
Returns a newVkMemoryType
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkMemoryType create()
Returns a newVkMemoryType
instance allocated withBufferUtils
.
-
create
public static VkMemoryType create(long address)
Returns a newVkMemoryType
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkMemoryType.Buffer malloc(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkMemoryType.Buffer calloc(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryType.Buffer create(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkMemoryType.Buffer create(long address, int capacity)
Create aVkMemoryType.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkMemoryType mallocStack()
Returns a newVkMemoryType
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkMemoryType callocStack()
Returns a newVkMemoryType
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkMemoryType mallocStack(MemoryStack stack)
Returns a newVkMemoryType
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkMemoryType callocStack(MemoryStack stack)
Returns a newVkMemoryType
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkMemoryType.Buffer mallocStack(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkMemoryType.Buffer callocStack(int capacity)
Returns a newVkMemoryType.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkMemoryType.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryType.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkMemoryType.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryType.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-