Package org.lwjgl.vulkan

Class VkPhysicalDeviceMemoryDecompressionFeaturesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceMemoryDecompressionFeaturesNV>

org.lwjgl.vulkan.VkPhysicalDeviceMemoryDecompressionFeaturesNV

All Implemented Interfaces:

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

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

Structure describing if memory decompression is supported by an implementation.

Description

If the VkPhysicalDeviceMemoryDecompressionFeaturesNV structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceMemoryDecompressionFeaturesNV can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV

Layout

 struct VkPhysicalDeviceMemoryDecompressionFeaturesNV {
     VkStructureType sType();
     void * pNext();
     VkBool32 memoryDecompression();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	An array of VkPhysicalDeviceMemoryDecompressionFeaturesNV 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	MEMORYDECOMPRESSION	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
VkPhysicalDeviceMemoryDecompressionFeaturesNV(ByteBuffer container)	Creates a VkPhysicalDeviceMemoryDecompressionFeaturesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	calloc()	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with memCalloc.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	create()	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	create(long address)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance for the specified memory address.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceMemoryDecompressionFeaturesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	malloc()	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with memAlloc.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMemoryDecompressionFeaturesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated on the specified MemoryStack.
boolean	memoryDecompression()	indicates whether memory decompression is supported.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	memoryDecompression(boolean value)	Sets the specified value to the memoryDecompression() field.
static int	nmemoryDecompression(long struct)	Unsafe version of memoryDecompression().
static void	nmemoryDecompression(long struct, int value)	Unsafe version of memoryDecompression.
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.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	set(int sType, long pNext, boolean memoryDecompression)	Initializes this struct with the specified values.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	set(VkPhysicalDeviceMemoryDecompressionFeaturesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceMemoryDecompressionFeaturesNV	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_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.

MEMORYDECOMPRESSION

public static final int MEMORYDECOMPRESSION

The struct member offsets.

Constructor Details

VkPhysicalDeviceMemoryDecompressionFeaturesNV

public VkPhysicalDeviceMemoryDecompressionFeaturesNV(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memoryDecompression

public boolean memoryDecompression()

indicates whether memory decompression is supported.

sType

public VkPhysicalDeviceMemoryDecompressionFeaturesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceMemoryDecompressionFeaturesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV value to the sType() field.

pNext

public VkPhysicalDeviceMemoryDecompressionFeaturesNV pNext(long value)

Sets the specified value to the pNext() field.

memoryDecompression

public VkPhysicalDeviceMemoryDecompressionFeaturesNV memoryDecompression(boolean value)

Sets the specified value to the memoryDecompression() field.

set

public VkPhysicalDeviceMemoryDecompressionFeaturesNV set(int sType,
 long pNext,
 boolean memoryDecompression)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceMemoryDecompressionFeaturesNV set(VkPhysicalDeviceMemoryDecompressionFeaturesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV malloc()

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

calloc

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV calloc()

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

create

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV create()

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with BufferUtils.

create

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceMemoryDecompressionFeaturesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemoryDecompression

public static int nmemoryDecompression(long struct)

Unsafe version of memoryDecompression().

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.

nmemoryDecompression

public static void nmemoryDecompression(long struct,
 int value)

Unsafe version of memoryDecompression.