VkPhysicalDeviceMemoryBudgetPropertiesEXT (LWJGL 3.2.4 SNAPSHOT

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.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)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_BUDGET_PROPERTIES_EXT
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- heapBudget[VK_MAX_MEMORY_HEAPS] – an array of MAX_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[VK_MAX_MEMORY_HEAPS] – an array of MAX_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.
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 and Description

static class VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer
An array of VkPhysicalDeviceMemoryBudgetPropertiesEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` An array of `VkPhysicalDeviceMemoryBudgetPropertiesEXT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`HEAPBUDGET` The struct member offsets.
`static int`	`HEAPUSAGE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkPhysicalDeviceMemoryBudgetPropertiesEXT(java.nio.ByteBuffer container)` Creates a `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`calloc()` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated with `memCalloc`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`calloc(int capacity)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated with `memCalloc`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`callocStack()` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`create()` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`create(int capacity)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`create(long address)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance for the specified memory address.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`create(long address, int capacity)` Create a `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance at the specified memory.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.LongBuffer`	`heapBudget()` Returns a `LongBuffer` view of the `heapBudget` field.
`long`	`heapBudget(int index)` Returns the value at the specified index of the `heapBudget` field.
`java.nio.LongBuffer`	`heapUsage()` Returns a `LongBuffer` view of the `heapUsage` field.
`long`	`heapUsage(int index)` Returns the value at the specified index of the `heapUsage` field.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`malloc()` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated with `memAlloc`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`malloc(int capacity)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated with `memAlloc`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`mallocStack()` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceMemoryBudgetPropertiesEXT` instance allocated on the specified `MemoryStack`.
`static java.nio.LongBuffer`	`nheapBudget(long struct)` Unsafe version of `heapBudget()`.
`static long`	`nheapBudget(long struct, int index)` Unsafe version of `heapBudget`.
`static java.nio.LongBuffer`	`nheapUsage(long struct)` Unsafe version of `heapUsage()`.
`static long`	`nheapUsage(long struct, int index)` Unsafe version of `heapUsage`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`set(VkPhysicalDeviceMemoryBudgetPropertiesEXT src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPhysicalDeviceMemoryBudgetPropertiesEXT`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - HEAPBUDGET
```
public static final int HEAPBUDGET
```
    The struct member offsets.
  - HEAPUSAGE
```
public static final int HEAPUSAGE
```
    The struct member offsets.
- Constructor Detail
  - VkPhysicalDeviceMemoryBudgetPropertiesEXT
```
public VkPhysicalDeviceMemoryBudgetPropertiesEXT(java.nio.ByteBuffer container)
```
    Creates a VkPhysicalDeviceMemoryBudgetPropertiesEXT instance at the current position of the specified ByteBuffer 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - heapBudget
```
public java.nio.LongBuffer heapBudget()
```
    Returns a LongBuffer view of the heapBudget field.
  - heapBudget
```
public long heapBudget(int index)
```
    Returns the value at the specified index of the heapBudget field.
  - heapUsage
```
public java.nio.LongBuffer heapUsage()
```
    Returns a LongBuffer view of the heapUsage field.
  - heapUsage
```
public long heapUsage(int index)
```
    Returns the value at the specified index of the heapUsage field.
  - sType
```
public VkPhysicalDeviceMemoryBudgetPropertiesEXT sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPhysicalDeviceMemoryBudgetPropertiesEXT pNext(long value)
```
    Sets the specified value to the pNext field.
  - 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 new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT calloc()
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT create()
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated with BufferUtils.
  - create
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT create(long address)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer malloc(int capacity)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer calloc(int capacity)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer create(int capacity)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer create(long address,
                                                                      int capacity)
```
    Create a VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer createSafe(long address,
                                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT mallocStack()
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT callocStack()
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer mallocStack(int capacity)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the thread-local MemoryStack and 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 new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer callocStack(int capacity,
                                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nheapBudget
```
public static java.nio.LongBuffer nheapBudget(long struct)
```
    Unsafe version of heapBudget().
  - nheapBudget
```
public static long nheapBudget(long struct,
                               int index)
```
    Unsafe version of heapBudget.
  - nheapUsage
```
public static java.nio.LongBuffer nheapUsage(long struct)
```
    Unsafe version of heapUsage().
  - nheapUsage
```
public static long nheapUsage(long struct,
                              int index)
```
    Unsafe version of heapUsage.
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.

Class VkPhysicalDeviceMemoryBudgetPropertiesEXT

Description

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

HEAPBUDGET

HEAPUSAGE

Constructor Detail

VkPhysicalDeviceMemoryBudgetPropertiesEXT

Method Detail

sizeof

sType

pNext

heapBudget

heapBudget

heapUsage

heapUsage

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nheapBudget

nheapBudget

nheapUsage

nheapUsage

nsType

npNext