Package org.lwjgl.vulkan
Class VkPhysicalDeviceMemoryBudgetPropertiesEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceMemoryBudgetPropertiesEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPhysicalDeviceMemoryBudgetPropertiesEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying physical device memory budget and usage.Description
The values returned in this structure are not invariant. The
heapBudgetandheapUsagevalues must be zero for array elements greater than or equal toVkPhysicalDeviceMemoryProperties::memoryHeapCount. TheheapBudgetvalue must be non-zero for array elements less thanVkPhysicalDeviceMemoryProperties::memoryHeapCount. TheheapBudgetvalue must be less than or equal toVkMemoryHeap::sizefor each heap.Valid Usage (Implicit)
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.heapBudget[VK_MAX_MEMORY_HEAPS]– an array of memory budgets, with one element for each memory heap. A heap’s budget is a rough estimate of how much memory the process can allocate from that heap before allocations may fail or cause performance degradation. The budget includes any currently allocated device memory.heapUsage[VK_MAX_MEMORY_HEAPS]– an array of memory usage, with one element for each memory heap. A heap’s usage is an estimate of how much memory the process is currently using in that heap.
Layout
struct VkPhysicalDeviceMemoryBudgetPropertiesEXT { VkStructureType sType; void * pNext; VkDeviceSize heapBudget[VK_MAX_MEMORY_HEAPS]; VkDeviceSize heapUsage[VK_MAX_MEMORY_HEAPS]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPhysicalDeviceMemoryBudgetPropertiesEXT.BufferAn array ofVkPhysicalDeviceMemoryBudgetPropertiesEXTstructs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceMemoryBudgetPropertiesEXT(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceMemoryBudgetPropertiesEXTcalloc()Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withmemCalloc.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceMemoryBudgetPropertiesEXTcallocStack()Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.BuffercallocStack(int capacity)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceMemoryBudgetPropertiesEXTcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceMemoryBudgetPropertiesEXTcreate()Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withBufferUtils.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffercreate(int capacity)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceMemoryBudgetPropertiesEXTcreate(long address)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance for the specified memory address.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance at the specified memory.static VkPhysicalDeviceMemoryBudgetPropertiesEXTcreateSafe(long address)static VkPhysicalDeviceMemoryBudgetPropertiesEXT.BuffercreateSafe(long address, int capacity)java.nio.LongBufferheapBudget()Returns aLongBufferview of theheapBudgetfield.longheapBudget(int index)Returns the value at the specified index of theheapBudgetfield.java.nio.LongBufferheapUsage()Returns aLongBufferview of theheapUsagefield.longheapUsage(int index)Returns the value at the specified index of theheapUsagefield.static VkPhysicalDeviceMemoryBudgetPropertiesEXTmalloc()Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withmemAlloc.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceMemoryBudgetPropertiesEXTmallocStack()Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.BuffermallocStack(int capacity)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceMemoryBudgetPropertiesEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceMemoryBudgetPropertiesEXTmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the specifiedMemoryStack.static java.nio.LongBuffernheapBudget(long struct)Unsafe version ofheapBudget().static longnheapBudget(long struct, int index)Unsafe version ofheapBudget.static java.nio.LongBuffernheapUsage(long struct)Unsafe version ofheapUsage().static longnheapUsage(long struct, int index)Unsafe version ofheapUsage.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()Returns the value of thepNextfield.VkPhysicalDeviceMemoryBudgetPropertiesEXTpNext(long value)Sets the specified value to thepNextfield.VkPhysicalDeviceMemoryBudgetPropertiesEXTset(int sType, long pNext)Initializes this struct with the specified values.VkPhysicalDeviceMemoryBudgetPropertiesEXTset(VkPhysicalDeviceMemoryBudgetPropertiesEXT src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkPhysicalDeviceMemoryBudgetPropertiesEXTsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkPhysicalDeviceMemoryBudgetPropertiesEXT
public VkPhysicalDeviceMemoryBudgetPropertiesEXT(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance 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()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
heapBudget
public java.nio.LongBuffer heapBudget()
Returns aLongBufferview of theheapBudgetfield.
-
heapBudget
public long heapBudget(int index)
Returns the value at the specified index of theheapBudgetfield.
-
heapUsage
public java.nio.LongBuffer heapUsage()
Returns aLongBufferview of theheapUsagefield.
-
heapUsage
public long heapUsage(int index)
Returns the value at the specified index of theheapUsagefield.
-
sType
public VkPhysicalDeviceMemoryBudgetPropertiesEXT sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPhysicalDeviceMemoryBudgetPropertiesEXT pNext(long value)
Sets the specified value to thepNextfield.
-
set
public VkPhysicalDeviceMemoryBudgetPropertiesEXT set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkPhysicalDeviceMemoryBudgetPropertiesEXT set(VkPhysicalDeviceMemoryBudgetPropertiesEXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT malloc()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT calloc()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT create()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT create(long address)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceMemoryBudgetPropertiesEXT createSafe(long address)
-
malloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer create(int capacity)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT mallocStack()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT callocStack()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nheapBudget
public static java.nio.LongBuffer nheapBudget(long struct)
Unsafe version ofheapBudget().
-
nheapBudget
public static long nheapBudget(long struct, int index)Unsafe version ofheapBudget.
-
nheapUsage
public static java.nio.LongBuffer nheapUsage(long struct)
Unsafe version ofheapUsage().
-
nheapUsage
public static long nheapUsage(long struct, int index)Unsafe version ofheapUsage.
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
-