Package org.lwjgl.vulkan
Class VkPhysicalDeviceMemoryBudgetPropertiesEXT
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceMemoryBudgetPropertiesEXT>
org.lwjgl.vulkan.VkPhysicalDeviceMemoryBudgetPropertiesEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkPhysicalDeviceMemoryBudgetPropertiesEXT
extends Struct<VkPhysicalDeviceMemoryBudgetPropertiesEXT>
implements NativeResource
Structure specifying physical device memory budget and usage.
Description
The values returned in this structure are not invariant. The heapBudget
and heapUsage
values must be zero for array elements greater than or equal to VkPhysicalDeviceMemoryProperties
::memoryHeapCount
. The heapBudget
value must be non-zero for array elements less than VkPhysicalDeviceMemoryProperties
::memoryHeapCount
. The heapBudget
value must be less than or equal to VkMemoryHeap
::size
for each heap.
Valid Usage (Implicit)
Layout
struct VkPhysicalDeviceMemoryBudgetPropertiesEXT {
VkStructureType sType()
;
void * pNext()
;
VkDeviceSize heapBudget()
[VK_MAX_MEMORY_HEAPS];
VkDeviceSize heapUsage()
[VK_MAX_MEMORY_HEAPS];
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPhysicalDeviceMemoryBudgetPropertiesEXT
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionCreates aVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory budgets are returned, with one element for each memory heap.long
heapBudget
(int index) an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory budgets are returned, with one element for each memory heap.an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory usages are returned, with one element for each memory heap.long
heapUsage
(int index) an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory usages are returned, with one element for each memory heap.malloc()
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static LongBuffer
nheapBudget
(long struct) Unsafe version ofheapBudget()
.static long
nheapBudget
(long struct, int index) Unsafe version ofheapBudget
.static LongBuffer
nheapUsage
(long struct) Unsafe version ofheapUsage()
.static long
nheapUsage
(long struct, int index) Unsafe version ofheapUsage
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_BUDGET_PROPERTIES_EXT
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
HEAPBUDGET
public static final int HEAPBUDGETThe struct member offsets. -
HEAPUSAGE
public static final int HEAPUSAGEThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceMemoryBudgetPropertiesEXT
Creates aVkPhysicalDeviceMemoryBudgetPropertiesEXT
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPhysicalDeviceMemoryBudgetPropertiesEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
heapBudget
an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory budgets are returned, 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. -
heapBudget
public long heapBudget(int index) an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory budgets are returned, 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
an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory usages are returned, 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. -
heapUsage
public long heapUsage(int index) an array ofMAX_MEMORY_HEAPS
VkDeviceSize
values in which memory usages are returned, 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. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_BUDGET_PROPERTIES_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated withBufferUtils
. -
create
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer mallocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nheapBudget
Unsafe version ofheapBudget()
. -
nheapBudget
public static long nheapBudget(long struct, int index) Unsafe version ofheapBudget
. -
nheapUsage
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
.
-