Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceMemoryDecompressionPropertiesNV

extends Struct<VkPhysicalDeviceMemoryDecompressionPropertiesNV>
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 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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DECOMPRESSIONMETHODS

The struct member offsets.

public static final int
MAXDECOMPRESSIONINDIRECTCOUNT

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
public
VkPhysicalDeviceMemoryDecompressionPropertiesNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV
calloc()

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkPhysicalDeviceMemoryDecompressionPropertiesNV
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 VkPhysicalDeviceMemoryDecompressionPropertiesNV
create()

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with BufferUtils.

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV
create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance at the specified memory.

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
decompressionMethods()

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

public static VkPhysicalDeviceMemoryDecompressionPropertiesNV
malloc()

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated on the specified MemoryStack.

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

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

public long
maxDecompressionIndirectCount()

specifies the maximum supported count value in the countBuffer of CmdDecompressMemoryIndirectCountNV

public static long
ndecompressionMethods(long struct)

Unsafe version of decompressionMethods.

public static long
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 VkPhysicalDeviceMemoryDecompressionPropertiesNV
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceMemoryDecompressionPropertiesNV
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceMemoryDecompressionPropertiesNV

Returns:

this struct
set
(VkPhysicalDeviceMemoryDecompressionPropertiesNV
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 VkPhysicalDeviceMemoryDecompressionPropertiesNV
sType(int value)

Sets the specified value to the sType field.

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

DECOMPRESSIONMETHODSback to summary
public static final int DECOMPRESSIONMETHODS

The struct member offsets.

MAXDECOMPRESSIONINDIRECTCOUNTback to summary
public static final int MAXDECOMPRESSIONINDIRECTCOUNT

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

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

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV calloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV 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 VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV create(long address)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
decompressionMethodsback to summary
public long decompressionMethods()

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

Annotations
@NativeType:VkMemoryDecompressionMethodFlagsNV
mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceMemoryDecompressionPropertiesNV malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryDecompressionPropertiesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

maxDecompressionIndirectCountback to summary
public long maxDecompressionIndirectCount()

specifies the maximum supported count value in the countBuffer of CmdDecompressMemoryIndirectCountNV

Annotations
@NativeType:uint64_t
ndecompressionMethodsback to summary
public static long ndecompressionMethods(long struct)

Unsafe version of decompressionMethods.

nmaxDecompressionIndirectCountback to summary
public static long nmaxDecompressionIndirectCount(long struct)

Unsafe version of maxDecompressionIndirectCount.

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 VkPhysicalDeviceMemoryDecompressionPropertiesNV pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceMemoryDecompressionPropertiesNV set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceMemoryDecompressionPropertiesNV set(VkPhysicalDeviceMemoryDecompressionPropertiesNV src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceMemoryDecompressionPropertiesNV

the source struct

Returns:VkPhysicalDeviceMemoryDecompressionPropertiesNV

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 VkPhysicalDeviceMemoryDecompressionPropertiesNV sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_PROPERTIES_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer

extends StructBuffer<VkPhysicalDeviceMemoryDecompressionPropertiesNV, VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPhysicalDeviceMemoryDecompressionPropertiesNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceMemoryDecompressionPropertiesNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.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
public long
protected VkPhysicalDeviceMemoryDecompressionPropertiesNV
public long
public long
public VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionPropertiesNV#pNext field.

protected VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer
public int
public VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionPropertiesNV#sType field.

public VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceMemoryDecompressionPropertiesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceMemoryDecompressionPropertiesNV.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 VkPhysicalDeviceMemoryDecompressionPropertiesNV#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

decompressionMethodsback to summary
public long decompressionMethods()
Returns:long

the value of the VkPhysicalDeviceMemoryDecompressionPropertiesNV#decompressionMethods field.

Annotations
@NativeType:VkMemoryDecompressionMethodFlagsNV
getElementFactoryback to summary
protected VkPhysicalDeviceMemoryDecompressionPropertiesNV getElementFactory()

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

Annotations
@Override
maxDecompressionIndirectCountback to summary
public long maxDecompressionIndirectCount()
Returns:long

the value of the VkPhysicalDeviceMemoryDecompressionPropertiesNV#maxDecompressionIndirectCount field.

Annotations
@NativeType:uint64_t
pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceMemoryDecompressionPropertiesNV#pNext field.

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

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionPropertiesNV#pNext field.

selfback to summary
protected VkPhysicalDeviceMemoryDecompressionPropertiesNV.Buffer self()

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

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

the value of the VkPhysicalDeviceMemoryDecompressionPropertiesNV#sType field.

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

Sets the specified value to the VkPhysicalDeviceMemoryDecompressionPropertiesNV#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_DECOMPRESSION_PROPERTIES_NV value to the VkPhysicalDeviceMemoryDecompressionPropertiesNV#sType field.