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

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 class	VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer	An array of VkPhysicalDeviceMemoryBudgetPropertiesEXT structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceMemoryBudgetPropertiesEXT(ByteBuffer container)	Creates a VkPhysicalDeviceMemoryBudgetPropertiesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryBudgetPropertiesEXT	calloc(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 @Nullable VkPhysicalDeviceMemoryBudgetPropertiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
LongBuffer	heapBudget()
long	heapBudget(int index)
LongBuffer	heapUsage()
long	heapUsage(int index)
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMemoryBudgetPropertiesEXT	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the specified MemoryStack.
static LongBuffer	nheapBudget(long struct)	Unsafe version of heapBudget().
static long	nheapBudget(long struct, int index)	Unsafe version of heapBudget.
static 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()
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()	Returns sizeof(struct).
int	sType()
VkPhysicalDeviceMemoryBudgetPropertiesEXT	sType(int value)	Sets the specified value to the sType field.
VkPhysicalDeviceMemoryBudgetPropertiesEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_BUDGET_PROPERTIES_EXT value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

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 Details

VkPhysicalDeviceMemoryBudgetPropertiesEXT

public VkPhysicalDeviceMemoryBudgetPropertiesEXT(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPhysicalDeviceMemoryBudgetPropertiesEXT>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

heapBudget

@NativeType("VkDeviceSize[VK_MAX_MEMORY_HEAPS]")
public LongBuffer heapBudget()

Returns:

a LongBuffer view of the heapBudget field.

heapBudget

@NativeType("VkDeviceSize")
public long heapBudget(int index)

Returns:

the value at the specified index of the heapBudget field.

heapUsage

@NativeType("VkDeviceSize[VK_MAX_MEMORY_HEAPS]")
public LongBuffer heapUsage()

Returns:

a LongBuffer view of the heapUsage field.

heapUsage

@NativeType("VkDeviceSize")
public long heapUsage(int index)

Returns:

the value at the specified index of the heapUsage field.

sType

public VkPhysicalDeviceMemoryBudgetPropertiesEXT sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkPhysicalDeviceMemoryBudgetPropertiesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_BUDGET_PROPERTIES_EXT value to the sType field.

pNext

public VkPhysicalDeviceMemoryBudgetPropertiesEXT pNext(@NativeType("void *")
 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

public static @Nullable 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

public static @Nullable VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMemoryBudgetPropertiesEXT malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceMemoryBudgetPropertiesEXT calloc(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

malloc

public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryBudgetPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

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 LongBuffer nheapBudget(long struct)

Unsafe version of heapBudget().

nheapBudget

public static long nheapBudget(long struct,
 int index)

Unsafe version of heapBudget.

nheapUsage

public static 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.