Package org.lwjgl.vulkan

Class VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV>

org.lwjgl.vulkan.VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV
extends org.lwjgl.system.Struct<VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV>
implements org.lwjgl.system.NativeResource

Structure describing sparse address space limits of an implementation.

Description

If the VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTENDED_SPARSE_ADDRESS_SPACE_PROPERTIES_NV

Layout

 struct VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV {
     VkStructureType sType();
     void * pNext();
     VkDeviceSize extendedSparseAddressSpaceSize();
     VkImageUsageFlags extendedSparseImageUsageFlags();
     VkBufferUsageFlags extendedSparseBufferUsageFlags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	An array of VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EXTENDEDSPARSEADDRESSSPACESIZE	The struct member offsets.
static final int	EXTENDEDSPARSEBUFFERUSAGEFLAGS	The struct member offsets.
static final int	EXTENDEDSPARSEIMAGEUSAGEFLAGS	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	calloc()	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with memCalloc.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	create()	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with BufferUtils.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	create(long address)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance for the specified memory address.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	extendedSparseAddressSpaceSize()	the total amount of address space available, in bytes, for sparse memory resources of all usages if the extendedSparseAddressSpace feature is enabled.
int	extendedSparseBufferUsageFlags()	a bitmask of VkBufferUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.
int	extendedSparseImageUsageFlags()	a bitmask of VkImageUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	malloc()	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with memAlloc.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated on the specified MemoryStack.
static long	nextendedSparseAddressSpaceSize(long struct)	Unsafe version of extendedSparseAddressSpaceSize().
static int	nextendedSparseBufferUsageFlags(long struct)	Unsafe version of extendedSparseBufferUsageFlags().
static int	nextendedSparseImageUsageFlags(long struct)	Unsafe version of extendedSparseImageUsageFlags().
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()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	set(VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTENDED_SPARSE_ADDRESS_SPACE_PROPERTIES_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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

EXTENDEDSPARSEADDRESSSPACESIZE

public static final int EXTENDEDSPARSEADDRESSSPACESIZE

The struct member offsets.

EXTENDEDSPARSEIMAGEUSAGEFLAGS

public static final int EXTENDEDSPARSEIMAGEUSAGEFLAGS

The struct member offsets.

EXTENDEDSPARSEBUFFERUSAGEFLAGS

public static final int EXTENDEDSPARSEBUFFERUSAGEFLAGS

The struct member offsets.

Constructor Details

VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV(ByteBuffer container)

Creates a VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

extendedSparseAddressSpaceSize

public long extendedSparseAddressSpaceSize()

the total amount of address space available, in bytes, for sparse memory resources of all usages if the extendedSparseAddressSpace feature is enabled. This must be greater than or equal to VkPhysicalDeviceLimits::sparseAddressSpaceSize, and the difference in space must only be used with usages allowed below. This is an upper bound on the sum of the sizes of all sparse resources, regardless of whether any memory is bound to them.

extendedSparseImageUsageFlags

public int extendedSparseImageUsageFlags()

a bitmask of VkImageUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.

extendedSparseBufferUsageFlags

public int extendedSparseBufferUsageFlags()

a bitmask of VkBufferUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.

sType

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTENDED_SPARSE_ADDRESS_SPACE_PROPERTIES_NV value to the sType() field.

pNext

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV set(VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV malloc()

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV calloc()

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV create()

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated with BufferUtils.

create

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV create(long address)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer malloc(int capacity)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer calloc(int capacity)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer create(long address,
 int capacity)

Create a VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.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().

nextendedSparseAddressSpaceSize

public static long nextendedSparseAddressSpaceSize(long struct)

Unsafe version of extendedSparseAddressSpaceSize().

nextendedSparseImageUsageFlags

public static int nextendedSparseImageUsageFlags(long struct)

Unsafe version of extendedSparseImageUsageFlags().

nextendedSparseBufferUsageFlags

public static int nextendedSparseBufferUsageFlags(long struct)

Unsafe version of extendedSparseBufferUsageFlags().

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.