Structure specifying decompression parameters.

Valid Usage

The srcAddress must be 4 byte aligned
The memory in range srcAddress and srcAddress + compressedSize must be valid and bound to a VkDeviceMemory object
The dstAddress must be 4 byte aligned
The memory in range dstAddress and dstAddress + decompressedSize must be valid and bound to a VkDeviceMemory object
The decompressedSize must be large enough to hold the decompressed data based on the decompressionMethod
The decompressionMethod must have a single bit set
The srcAddress to srcAddress + compressedSize region must not overlap with the dstAddress and dstAddress + decompressedSize region

Valid Usage (Implicit)

decompressionMethod must be a valid combination of VkMemoryDecompressionMethodFlagBitsNV values
decompressionMethod must not be 0

Layout


struct VkDecompressMemoryRegionNV {
    VkDeviceAddress srcAddress;
    VkDeviceAddress dstAddress;
    VkDeviceSize compressedSize;
    VkDeviceSize decompressedSize;
    VkMemoryDecompressionMethodFlagsNV decompressionMethod;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkDecompressMemoryRegionNV.Buffer An array of `VkDecompressMemoryRegionNV` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COMPRESSEDSIZE The struct member offsets.
public static final int	DECOMPRESSEDSIZE The struct member offsets.
public static final int	DECOMPRESSIONMETHOD The struct member offsets.
public static final int	DSTADDRESS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRCADDRESS The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkDecompressMemoryRegionNV(long address, ByteBuffer container)
public	VkDecompressMemoryRegionNV(ByteBuffer container) Creates a `VkDecompressMemoryRegionNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkDecompressMemoryRegionNV	calloc() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `memCalloc`.
public static VkDecompressMemoryRegionNV.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `memCalloc`.
public static VkDecompressMemoryRegionNV	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDecompressMemoryRegionNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDecompressMemoryRegionNV.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public long	compressedSize() the size of compressed data in bytes.
public VkDecompressMemoryRegionNV	compressedSize(long value) Sets the specified value to the `compressedSize` field.
protected VkDecompressMemoryRegionNV	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 VkDecompressMemoryRegionNV	create() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `BufferUtils`.
public static VkDecompressMemoryRegionNV	create(long address) Returns a new `VkDecompressMemoryRegionNV` instance for the specified memory address.
public static VkDecompressMemoryRegionNV.Buffer	create(int the buffer capacity capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `BufferUtils`.
public static VkDecompressMemoryRegionNV.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDecompressMemoryRegionNV.Buffer` instance at the specified memory.
public static VkDecompressMemoryRegionNV	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDecompressMemoryRegionNV.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	decompressedSize() the size of decompressed data in bytes.
public VkDecompressMemoryRegionNV	decompressedSize(long value) Sets the specified value to the `decompressedSize` field.
public long	decompressionMethod() a bitmask of `VkMemoryDecompressionMethodFlagBitsNV` with a single bit set specifying the method used to decompress data.
public VkDecompressMemoryRegionNV	decompressionMethod(long value) Sets the specified value to the `decompressionMethod` field.
public long	dstAddress() the destination address where decompressed data will be written.
public VkDecompressMemoryRegionNV	dstAddress(long value) Sets the specified value to the `dstAddress` field.
public static VkDecompressMemoryRegionNV	malloc() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `memAlloc`.
public static VkDecompressMemoryRegionNV.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `memAlloc`.
public static VkDecompressMemoryRegionNV	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDecompressMemoryRegionNV` instance allocated on the specified `MemoryStack`.
public static VkDecompressMemoryRegionNV.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated on the specified `MemoryStack`.
public static long	ncompressedSize(long struct) Unsafe version of `compressedSize`.
public static void	ncompressedSize(long struct, long value) Unsafe version of `compressedSize`.
public static long	ndecompressedSize(long struct) Unsafe version of `decompressedSize`.
public static void	ndecompressedSize(long struct, long value) Unsafe version of `decompressedSize`.
public static long	ndecompressionMethod(long struct) Unsafe version of `decompressionMethod`.
public static void	ndecompressionMethod(long struct, long value) Unsafe version of `decompressionMethod`.
public static long	ndstAddress(long struct) Unsafe version of `dstAddress`.
public static void	ndstAddress(long struct, long value) Unsafe version of `dstAddress`.
public static long	nsrcAddress(long struct) Unsafe version of `srcAddress`.
public static void	nsrcAddress(long struct, long value) Unsafe version of `srcAddress`.
public VkDecompressMemoryRegionNV	set(long srcAddress, long dstAddress, long compressedSize, long decompressedSize, long decompressionMethod) Initializes this struct with the specified values.
public VkDecompressMemoryRegionNV	Returns: this struct set(VkDecompressMemoryRegionNV 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 long	srcAddress() the address where compressed data is stored.
public VkDecompressMemoryRegionNV	srcAddress(long value) Sets the specified value to the `srcAddress` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COMPRESSEDSIZE	back to summary
public static final int COMPRESSEDSIZE The struct member offsets.

DECOMPRESSEDSIZE	back to summary
public static final int DECOMPRESSEDSIZE The struct member offsets.

DECOMPRESSIONMETHOD	back to summary
public static final int DECOMPRESSIONMETHOD The struct member offsets.

DSTADDRESS	back to summary
public static final int DSTADDRESS The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

SRCADDRESS	back to summary
public static final int SRCADDRESS The struct member offsets.

Constructor Detail

VkDecompressMemoryRegionNV	back to summary
protected VkDecompressMemoryRegionNV(long address, ByteBuffer container)

VkDecompressMemoryRegionNV back to summary

VkDecompressMemoryRegionNV	back to summary
public VkDecompressMemoryRegionNV(ByteBuffer container) Creates a `VkDecompressMemoryRegionNV` 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.

public VkDecompressMemoryRegionNV(ByteBuffer container)

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

calloc	back to summary
public static VkDecompressMemoryRegionNV calloc() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkDecompressMemoryRegionNV.Buffer calloc(int capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDecompressMemoryRegionNV.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkDecompressMemoryRegionNV calloc(MemoryStack stack) Returns a new `VkDecompressMemoryRegionNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkDecompressMemoryRegionNV calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkDecompressMemoryRegionNV.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkDecompressMemoryRegionNV.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

public static VkDecompressMemoryRegionNV.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDecompressMemoryRegionNV.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

compressedSize	back to summary
public long compressedSize() the size of compressed data in bytes. Annotations @NativeType:VkDeviceSize

compressedSize

back to summary

public long compressedSize()

the size of compressed data in bytes.

Annotations

@NativeType:VkDeviceSize

compressedSize	back to summary
public VkDecompressMemoryRegionNV compressedSize(long value) Sets the specified value to the `compressedSize` field.

create back to summary

create	back to summary
protected VkDecompressMemoryRegionNV 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

protected VkDecompressMemoryRegionNV 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

create	back to summary
public static VkDecompressMemoryRegionNV create() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `BufferUtils`.

create	back to summary
public static VkDecompressMemoryRegionNV create(long address) Returns a new `VkDecompressMemoryRegionNV` instance for the specified memory address.

create back to summary

create	back to summary
public static VkDecompressMemoryRegionNV.Buffer create(int capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkDecompressMemoryRegionNV.Buffer create(int capacity)

Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkDecompressMemoryRegionNV.Buffer create(long address, int capacity) Create a `VkDecompressMemoryRegionNV.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkDecompressMemoryRegionNV.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkDecompressMemoryRegionNV createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkDecompressMemoryRegionNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkDecompressMemoryRegionNV.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

decompressedSize	back to summary
public long decompressedSize() the size of decompressed data in bytes. Annotations @NativeType:VkDeviceSize

decompressedSize

back to summary

public long decompressedSize()

the size of decompressed data in bytes.

Annotations

@NativeType:VkDeviceSize

decompressedSize	back to summary
public VkDecompressMemoryRegionNV decompressedSize(long value) Sets the specified value to the `decompressedSize` field.

decompressionMethod back to summary

decompressionMethod	back to summary
public long decompressionMethod() a bitmask of `VkMemoryDecompressionMethodFlagBitsNV` with a single bit set specifying the method used to decompress data. Annotations @NativeType:VkMemoryDecompressionMethodFlagsNV

public long decompressionMethod()

a bitmask of VkMemoryDecompressionMethodFlagBitsNV with a single bit set specifying the method used to decompress data.

Annotations

@NativeType:VkMemoryDecompressionMethodFlagsNV

decompressionMethod	back to summary
public VkDecompressMemoryRegionNV decompressionMethod(long value) Sets the specified value to the `decompressionMethod` field.

dstAddress	back to summary
public long dstAddress() the destination address where decompressed data will be written. Annotations @NativeType:VkDeviceAddress

dstAddress

back to summary

public long dstAddress()

the destination address where decompressed data will be written.

Annotations

@NativeType:VkDeviceAddress

dstAddress	back to summary
public VkDecompressMemoryRegionNV dstAddress(long value) Sets the specified value to the `dstAddress` field.

malloc	back to summary
public static VkDecompressMemoryRegionNV malloc() Returns a new `VkDecompressMemoryRegionNV` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkDecompressMemoryRegionNV.Buffer malloc(int capacity) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDecompressMemoryRegionNV.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkDecompressMemoryRegionNV malloc(MemoryStack stack) Returns a new `VkDecompressMemoryRegionNV` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkDecompressMemoryRegionNV malloc(MemoryStack stack)

Returns a new VkDecompressMemoryRegionNV instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkDecompressMemoryRegionNV.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkDecompressMemoryRegionNV.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkDecompressMemoryRegionNV.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ncompressedSize	back to summary
public static long ncompressedSize(long struct) Unsafe version of `compressedSize`.

ncompressedSize	back to summary
public static void ncompressedSize(long struct, long value) Unsafe version of `compressedSize`.

ndecompressedSize	back to summary
public static long ndecompressedSize(long struct) Unsafe version of `decompressedSize`.

ndecompressedSize	back to summary
public static void ndecompressedSize(long struct, long value) Unsafe version of `decompressedSize`.

ndecompressionMethod	back to summary
public static long ndecompressionMethod(long struct) Unsafe version of `decompressionMethod`.

ndecompressionMethod	back to summary
public static void ndecompressionMethod(long struct, long value) Unsafe version of `decompressionMethod`.

ndstAddress	back to summary
public static long ndstAddress(long struct) Unsafe version of `dstAddress`.

ndstAddress	back to summary
public static void ndstAddress(long struct, long value) Unsafe version of `dstAddress`.

nsrcAddress	back to summary
public static long nsrcAddress(long struct) Unsafe version of `srcAddress`.

nsrcAddress	back to summary
public static void nsrcAddress(long struct, long value) Unsafe version of `srcAddress`.

set	back to summary
public VkDecompressMemoryRegionNV set(long srcAddress, long dstAddress, long compressedSize, long decompressedSize, long decompressionMethod) Initializes this struct with the specified values.

set	back to summary
public VkDecompressMemoryRegionNV set(VkDecompressMemoryRegionNV src) Copies the specified struct data to this struct. Parameters src:VkDecompressMemoryRegionNV the source struct Returns:VkDecompressMemoryRegionNV this struct

set

back to summary

public VkDecompressMemoryRegionNV set(VkDecompressMemoryRegionNV src)

Copies the specified struct data to this struct.

Parameters

src:VkDecompressMemoryRegionNV: the source struct

Returns:VkDecompressMemoryRegionNV

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

srcAddress	back to summary
public long srcAddress() the address where compressed data is stored. Annotations @NativeType:VkDeviceAddress

srcAddress

back to summary

public long srcAddress()

the address where compressed data is stored.

Annotations

@NativeType:VkDeviceAddress

srcAddress	back to summary
public VkDecompressMemoryRegionNV srcAddress(long value) Sets the specified value to the `srcAddress` field.

org.lwjgl.vulkan back to summary

public Class VkDecompressMemoryRegionNV.Buffer

Class Inheritance

extends StructBuffer<VkDecompressMemoryRegionNV, VkDecompressMemoryRegionNV.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkDecompressMemoryRegionNV.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDecompressMemoryRegionNV structs.

Field Summary

Modifier and Type	Field and Description
private static final VkDecompressMemoryRegionNV	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkDecompressMemoryRegionNV.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 Type	Method and Description
public long	Returns: the value of the `VkDecompressMemoryRegionNV#compressedSize` field. compressedSize()
public VkDecompressMemoryRegionNV.Buffer	compressedSize(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#compressedSize` field.
public long	Returns: the value of the `VkDecompressMemoryRegionNV#decompressedSize` field. decompressedSize()
public VkDecompressMemoryRegionNV.Buffer	decompressedSize(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#decompressedSize` field.
public long	Returns: the value of the `VkDecompressMemoryRegionNV#decompressionMethod` field. decompressionMethod()
public VkDecompressMemoryRegionNV.Buffer	decompressionMethod(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#decompressionMethod` field.
public long	Returns: the value of the `VkDecompressMemoryRegionNV#dstAddress` field. dstAddress()
public VkDecompressMemoryRegionNV.Buffer	dstAddress(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#dstAddress` field.
protected VkDecompressMemoryRegionNV	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkDecompressMemoryRegionNV.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkDecompressMemoryRegionNV#srcAddress` field. srcAddress()
public VkDecompressMemoryRegionNV.Buffer	srcAddress(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#srcAddress` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkDecompressMemoryRegionNV ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkDecompressMemoryRegionNV.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 VkDecompressMemoryRegionNV#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

compressedSize	back to summary
public long compressedSize() Returns:long the value of the `VkDecompressMemoryRegionNV#compressedSize` field. Annotations @NativeType:VkDeviceSize

compressedSize	back to summary
public VkDecompressMemoryRegionNV.Buffer compressedSize(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#compressedSize` field.

decompressedSize	back to summary
public long decompressedSize() Returns:long the value of the `VkDecompressMemoryRegionNV#decompressedSize` field. Annotations @NativeType:VkDeviceSize

decompressedSize	back to summary
public VkDecompressMemoryRegionNV.Buffer decompressedSize(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#decompressedSize` field.

decompressionMethod	back to summary
public long decompressionMethod() Returns:long the value of the `VkDecompressMemoryRegionNV#decompressionMethod` field. Annotations @NativeType:VkMemoryDecompressionMethodFlagsNV

decompressionMethod	back to summary
public VkDecompressMemoryRegionNV.Buffer decompressionMethod(long value) Sets the specified value to the `VkDecompressMemoryRegionNV#decompressionMethod` field.