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 ofVkMemoryPropertyFlagBitsproperties for this memory type. One or more of:MEMORY_PROPERTY_DEVICE_LOCAL_BITMEMORY_PROPERTY_HOST_CACHED_BITMEMORY_PROPERTY_HOST_COHERENT_BITMEMORY_PROPERTY_HOST_VISIBLE_BITMEMORY_PROPERTY_LAZILY_ALLOCATED_BITheapIndex– describes which memory heap this memory type corresponds to, and must be less thanmemoryHeapCountfrom theVkPhysicalDeviceMemoryPropertiesstructure
Layout
struct VkMemoryType { VkMemoryPropertyFlags propertyFlags; uint32_t heapIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkMemoryType.BufferAn array ofVkMemoryTypestructs.-
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 VkMemoryType(java.nio.ByteBuffer container)Creates aVkMemoryTypeinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkMemoryTypecalloc()Returns a newVkMemoryTypeinstance allocated withmemCalloc.static VkMemoryType.Buffercalloc(int capacity)Returns a newVkMemoryType.Bufferinstance allocated withmemCalloc.static VkMemoryTypecallocStack()Returns a newVkMemoryTypeinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkMemoryType.BuffercallocStack(int capacity)Returns a newVkMemoryType.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkMemoryType.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkMemoryType.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkMemoryTypecallocStack(MemoryStack stack)Returns a newVkMemoryTypeinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkMemoryTypecreate()Returns a newVkMemoryTypeinstance allocated withBufferUtils.static VkMemoryType.Buffercreate(int capacity)Returns a newVkMemoryType.Bufferinstance allocated withBufferUtils.static VkMemoryTypecreate(long address)Returns a newVkMemoryTypeinstance for the specified memory address ornullif the address isNULL.static VkMemoryType.Buffercreate(long address, int capacity)Create aVkMemoryType.Bufferinstance at the specified memory.intheapIndex()Returns the value of theheapIndexfield.static VkMemoryTypemalloc()Returns a newVkMemoryTypeinstance allocated withmemAlloc.static VkMemoryType.Buffermalloc(int capacity)Returns a newVkMemoryType.Bufferinstance allocated withmemAlloc.static VkMemoryTypemallocStack()Returns a newVkMemoryTypeinstance allocated on the thread-localMemoryStack.static VkMemoryType.BuffermallocStack(int capacity)Returns a newVkMemoryType.Bufferinstance allocated on the thread-localMemoryStack.static VkMemoryType.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkMemoryType.Bufferinstance allocated on the specifiedMemoryStack.static VkMemoryTypemallocStack(MemoryStack stack)Returns a newVkMemoryTypeinstance allocated on the specifiedMemoryStack.intpropertyFlags()Returns the value of thepropertyFlagsfield.intsizeof()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 aVkMemoryTypeinstance 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).
-
propertyFlags
public int propertyFlags()
Returns the value of thepropertyFlagsfield.
-
heapIndex
public int heapIndex()
Returns the value of theheapIndexfield.
-
malloc
public static VkMemoryType malloc()
Returns a newVkMemoryTypeinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkMemoryType calloc()
Returns a newVkMemoryTypeinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkMemoryType create()
Returns a newVkMemoryTypeinstance allocated withBufferUtils.
-
create
public static VkMemoryType create(long address)
Returns a newVkMemoryTypeinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkMemoryType.Buffer malloc(int capacity)
Returns a newVkMemoryType.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkMemoryType.Buffer calloc(int capacity)
Returns a newVkMemoryType.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkMemoryType.Buffer create(int capacity)
Returns a newVkMemoryType.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkMemoryType.Buffer create(long address, int capacity)
Create aVkMemoryType.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkMemoryType mallocStack()
Returns a newVkMemoryTypeinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkMemoryType callocStack()
Returns a newVkMemoryTypeinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkMemoryType mallocStack(MemoryStack stack)
Returns a newVkMemoryTypeinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkMemoryType callocStack(MemoryStack stack)
Returns a newVkMemoryTypeinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkMemoryType.Buffer callocStack(int capacity)
Returns a newVkMemoryType.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkMemoryType.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkMemoryType.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-