Package org.lwjgl.vulkan

Class VkPhysicalDeviceMemoryDecompressionPropertiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceMemoryDecompressionPropertiesNV>

org.lwjgl.vulkan.VkPhysicalDeviceMemoryDecompressionPropertiesNV

All Implemented Interfaces:

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

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

Structure describing supported memory decompression methods by an implementation.

Description

If the VkPhysicalDeviceMemoryDecompressionPropertiesNV 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_MEMORY_DECOMPRESSION_PROPERTIES_NV

Layout

 struct VkPhysicalDeviceMemoryDecompressionPropertiesNV {
     VkStructureType sType();
     void * pNext();
     VkMemoryDecompressionMethodFlagsNV decompressionMethods();
     uint64_t maxDecompressionIndirectCount();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	An array of VkPhysicalDeviceMemoryDecompressionPropertiesNV 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	DECOMPRESSIONMETHODS	The struct member offsets.
static final int	MAXDECOMPRESSIONINDIRECTCOUNT	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
VkPhysicalDeviceMemoryDecompressionPropertiesNV(ByteBuffer container)	Creates a VkPhysicalDeviceMemoryDecompressionPropertiesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	calloc()	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with memCalloc.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	create()	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	create(long address)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance for the specified memory address.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceMemoryDecompressionPropertiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	decompressionMethods()	a bitmask of VkMemoryDecompressionMethodFlagBitsNV specifying memory decompression methods supported by the implementation.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	malloc()	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with memAlloc.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMemoryDecompressionPropertiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated on the specified MemoryStack.
long	maxDecompressionIndirectCount()	specifies the maximum supported count value in the countBuffer of CmdDecompressMemoryIndirectCountNV
static long	ndecompressionMethods(long struct)	Unsafe version of decompressionMethods().
static long	nmaxDecompressionIndirectCount(long struct)	Unsafe version of maxDecompressionIndirectCount().
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.
VkPhysicalDeviceMemoryDecompressionPropertiesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceMemoryDecompressionPropertiesNV	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceMemoryDecompressionPropertiesNV	set(VkPhysicalDeviceMemoryDecompressionPropertiesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceMemoryDecompressionPropertiesNV	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceMemoryDecompressionPropertiesNV	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_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.

DECOMPRESSIONMETHODS

public static final int DECOMPRESSIONMETHODS

The struct member offsets.

MAXDECOMPRESSIONINDIRECTCOUNT

public static final int MAXDECOMPRESSIONINDIRECTCOUNT

The struct member offsets.

Constructor Details

VkPhysicalDeviceMemoryDecompressionPropertiesNV

public VkPhysicalDeviceMemoryDecompressionPropertiesNV(ByteBuffer container)

Creates a VkPhysicalDeviceMemoryDecompressionPropertiesNV 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<VkPhysicalDeviceMemoryDecompressionPropertiesNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

decompressionMethods

public long decompressionMethods()

a bitmask of VkMemoryDecompressionMethodFlagBitsNV specifying memory decompression methods supported by the implementation.

maxDecompressionIndirectCount

public long maxDecompressionIndirectCount()

specifies the maximum supported count value in the countBuffer of CmdDecompressMemoryIndirectCountNV

sType

public VkPhysicalDeviceMemoryDecompressionPropertiesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceMemoryDecompressionPropertiesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_PROPERTIES_NV value to the sType() field.

pNext

public VkPhysicalDeviceMemoryDecompressionPropertiesNV pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceMemoryDecompressionPropertiesNV set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceMemoryDecompressionPropertiesNV set(VkPhysicalDeviceMemoryDecompressionPropertiesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV malloc()

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

calloc

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV calloc()

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

create

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV create()

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with BufferUtils.

create

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceMemoryDecompressionPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndecompressionMethods

public static long ndecompressionMethods(long struct)

Unsafe version of decompressionMethods().

nmaxDecompressionIndirectCount

public static long nmaxDecompressionIndirectCount(long struct)

Unsafe version of maxDecompressionIndirectCount().

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.