Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceMemoryDecompressionFeaturesNV

extends Struct<VkPhysicalDeviceMemoryDecompressionFeaturesNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer

An array of VkPhysicalDeviceMemoryDecompressionFeaturesNV structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MEMORYDECOMPRESSION

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPhysicalDeviceMemoryDecompressionFeaturesNV(long address, ByteBuffer container)

public
VkPhysicalDeviceMemoryDecompressionFeaturesNV(ByteBuffer container)

Creates a VkPhysicalDeviceMemoryDecompressionFeaturesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
calloc()

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with memCalloc.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with memCalloc.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

protected VkPhysicalDeviceMemoryDecompressionFeaturesNV
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
create()

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with BufferUtils.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance for the specified memory address.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance at the specified memory.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
malloc()

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with memAlloc.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with memAlloc.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated on the specified MemoryStack.

public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public boolean
memoryDecompression()

indicates whether memory decompression is supported.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV
memoryDecompression(boolean value)

Sets the specified value to the memoryDecompression field.

public static int
nmemoryDecompression(long struct)

Unsafe version of memoryDecompression.

public static void
nmemoryDecompression(long struct, int value)

Unsafe version of memoryDecompression.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV

Returns:

this struct
set(VkPhysicalDeviceMemoryDecompressionFeaturesNV
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MEMORYDECOMPRESSIONback to summary
public static final int MEMORYDECOMPRESSION

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPhysicalDeviceMemoryDecompressionFeaturesNVback to summary
protected VkPhysicalDeviceMemoryDecompressionFeaturesNV(long address, ByteBuffer container)
VkPhysicalDeviceMemoryDecompressionFeaturesNVback to summary
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 Detail

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV calloc()

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

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkPhysicalDeviceMemoryDecompressionFeaturesNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV create()

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance for the specified memory address.

createback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV malloc()

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

mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryDecompressionFeaturesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

memoryDecompressionback to summary
public boolean memoryDecompression()

indicates whether memory decompression is supported.

Annotations
@NativeType:VkBool32
memoryDecompressionback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV memoryDecompression(boolean value)

Sets the specified value to the memoryDecompression field.

nmemoryDecompressionback to summary
public static int nmemoryDecompression(long struct)

Unsafe version of memoryDecompression.

nmemoryDecompressionback to summary
public static void nmemoryDecompression(long struct, int value)

Unsafe version of memoryDecompression.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV set(VkPhysicalDeviceMemoryDecompressionFeaturesNV src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceMemoryDecompressionFeaturesNV

the source struct

Returns:VkPhysicalDeviceMemoryDecompressionFeaturesNV

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer

extends StructBuffer<VkPhysicalDeviceMemoryDecompressionFeaturesNV, VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkPhysicalDeviceMemoryDecompressionFeaturesNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceMemoryDecompressionFeaturesNV
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkPhysicalDeviceMemoryDecompressionFeaturesNV
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public boolean

Returns:

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#memoryDecompression field.
memoryDecompression()

public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
memoryDecompression(boolean value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#memoryDecompression field.

public long

Returns:

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#pNext field.
pNext()

public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#pNext field.

protected VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.
sType()

public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.

public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceMemoryDecompressionFeaturesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPhysicalDeviceMemoryDecompressionFeaturesNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkPhysicalDeviceMemoryDecompressionFeaturesNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
memoryDecompressionback to summary
public boolean memoryDecompression()
Returns:boolean

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#memoryDecompression field.

Annotations
@NativeType:VkBool32
memoryDecompressionback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer memoryDecompression(boolean value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#memoryDecompression field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer pNext(long value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#pNext field.

selfback to summary
protected VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer sType(int value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.

sType$Defaultback to summary
public VkPhysicalDeviceMemoryDecompressionFeaturesNV.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_FEATURES_NV value to the VkPhysicalDeviceMemoryDecompressionFeaturesNV#sType field.