Class VkDecompressMemoryRegionNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDecompressMemoryRegionNV>

org.lwjgl.vulkan.VkDecompressMemoryRegionNV

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDecompressMemoryRegionNV
extends Struct<VkDecompressMemoryRegionNV>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDecompressMemoryRegionNV(ByteBuffer container)	Creates a VkDecompressMemoryRegionNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDecompressMemoryRegionNV	calloc()	Returns a new VkDecompressMemoryRegionNV instance allocated with memCalloc.
static VkDecompressMemoryRegionNV.Buffer	calloc(int capacity)	Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated with memCalloc.
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.
static VkDecompressMemoryRegionNV	calloc(MemoryStack stack)	Returns a new VkDecompressMemoryRegionNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
long	compressedSize()
VkDecompressMemoryRegionNV	compressedSize(long value)	Sets the specified value to the compressedSize field.
static VkDecompressMemoryRegionNV	create()	Returns a new VkDecompressMemoryRegionNV instance allocated with BufferUtils.
static VkDecompressMemoryRegionNV.Buffer	create(int capacity)	Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated with BufferUtils.
static VkDecompressMemoryRegionNV	create(long address)	Returns a new VkDecompressMemoryRegionNV instance for the specified memory address.
static VkDecompressMemoryRegionNV.Buffer	create(long address, int capacity)	Create a VkDecompressMemoryRegionNV.Buffer instance at the specified memory.
static @Nullable VkDecompressMemoryRegionNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDecompressMemoryRegionNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	decompressedSize()
VkDecompressMemoryRegionNV	decompressedSize(long value)	Sets the specified value to the decompressedSize field.
long	decompressionMethod()
VkDecompressMemoryRegionNV	decompressionMethod(long value)	Sets the specified value to the decompressionMethod field.
long	dstAddress()
VkDecompressMemoryRegionNV	dstAddress(long value)	Sets the specified value to the dstAddress field.
static VkDecompressMemoryRegionNV	malloc()	Returns a new VkDecompressMemoryRegionNV instance allocated with memAlloc.
static VkDecompressMemoryRegionNV.Buffer	malloc(int capacity)	Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated with memAlloc.
static VkDecompressMemoryRegionNV.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated on the specified MemoryStack.
static VkDecompressMemoryRegionNV	malloc(MemoryStack stack)	Returns a new VkDecompressMemoryRegionNV instance allocated on the specified MemoryStack.
static long	ncompressedSize(long struct)	Unsafe version of compressedSize().
static void	ncompressedSize(long struct, long value)	Unsafe version of compressedSize.
static long	ndecompressedSize(long struct)	Unsafe version of decompressedSize().
static void	ndecompressedSize(long struct, long value)	Unsafe version of decompressedSize.
static long	ndecompressionMethod(long struct)	Unsafe version of decompressionMethod().
static void	ndecompressionMethod(long struct, long value)	Unsafe version of decompressionMethod.
static long	ndstAddress(long struct)	Unsafe version of dstAddress().
static void	ndstAddress(long struct, long value)	Unsafe version of dstAddress.
static long	nsrcAddress(long struct)	Unsafe version of srcAddress().
static void	nsrcAddress(long struct, long value)	Unsafe version of srcAddress.
VkDecompressMemoryRegionNV	set(long srcAddress, long dstAddress, long compressedSize, long decompressedSize, long decompressionMethod)	Initializes this struct with the specified values.
VkDecompressMemoryRegionNV	set(VkDecompressMemoryRegionNV src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	srcAddress()
VkDecompressMemoryRegionNV	srcAddress(long value)	Sets the specified value to the srcAddress field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

SRCADDRESS

public static final int SRCADDRESS

The struct member offsets.

DSTADDRESS

public static final int DSTADDRESS

The struct member offsets.

COMPRESSEDSIZE

public static final int COMPRESSEDSIZE

The struct member offsets.

DECOMPRESSEDSIZE

public static final int DECOMPRESSEDSIZE

The struct member offsets.

DECOMPRESSIONMETHOD

public static final int DECOMPRESSIONMETHOD

The struct member offsets.

Constructor Details

VkDecompressMemoryRegionNV

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDecompressMemoryRegionNV>

srcAddress

@NativeType("VkDeviceAddress")
public long srcAddress()

Returns:

the value of the srcAddress field.

dstAddress

@NativeType("VkDeviceAddress")
public long dstAddress()

Returns:

the value of the dstAddress field.

compressedSize

@NativeType("VkDeviceSize")
public long compressedSize()

Returns:

the value of the compressedSize field.

decompressedSize

@NativeType("VkDeviceSize")
public long decompressedSize()

Returns:

the value of the decompressedSize field.

decompressionMethod

@NativeType("VkMemoryDecompressionMethodFlagsNV")
public long decompressionMethod()

Returns:

the value of the decompressionMethod field.

srcAddress

public VkDecompressMemoryRegionNV srcAddress(@NativeType("VkDeviceAddress")
 long value)

Sets the specified value to the srcAddress field.

dstAddress

public VkDecompressMemoryRegionNV dstAddress(@NativeType("VkDeviceAddress")
 long value)

Sets the specified value to the dstAddress field.

compressedSize

public VkDecompressMemoryRegionNV compressedSize(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the compressedSize field.

decompressedSize

public VkDecompressMemoryRegionNV decompressedSize(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the decompressedSize field.

decompressionMethod

public VkDecompressMemoryRegionNV decompressionMethod(@NativeType("VkMemoryDecompressionMethodFlagsNV")
 long value)

Sets the specified value to the decompressionMethod field.

set

public VkDecompressMemoryRegionNV set(long srcAddress,
 long dstAddress,
 long compressedSize,
 long decompressedSize,
 long decompressionMethod)

Initializes this struct with the specified values.

set

public VkDecompressMemoryRegionNV set(VkDecompressMemoryRegionNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDecompressMemoryRegionNV malloc()

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

calloc

public static VkDecompressMemoryRegionNV calloc()

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

create

public static VkDecompressMemoryRegionNV create()

Returns a new VkDecompressMemoryRegionNV instance allocated with BufferUtils.

create

public static VkDecompressMemoryRegionNV create(long address)

Returns a new VkDecompressMemoryRegionNV instance for the specified memory address.

createSafe

public static @Nullable VkDecompressMemoryRegionNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDecompressMemoryRegionNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDecompressMemoryRegionNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDecompressMemoryRegionNV.Buffer create(int capacity)

Returns a new VkDecompressMemoryRegionNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDecompressMemoryRegionNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDecompressMemoryRegionNV malloc(MemoryStack stack)

Returns a new VkDecompressMemoryRegionNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsrcAddress

public static long nsrcAddress(long struct)

Unsafe version of srcAddress().

ndstAddress

public static long ndstAddress(long struct)

Unsafe version of dstAddress().

ncompressedSize

public static long ncompressedSize(long struct)

Unsafe version of compressedSize().

ndecompressedSize

public static long ndecompressedSize(long struct)

Unsafe version of decompressedSize().

ndecompressionMethod

public static long ndecompressionMethod(long struct)

Unsafe version of decompressionMethod().

nsrcAddress

public static void nsrcAddress(long struct,
 long value)

Unsafe version of srcAddress.

ndstAddress

public static void ndstAddress(long struct,
 long value)

Unsafe version of dstAddress.

ncompressedSize

public static void ncompressedSize(long struct,
 long value)

Unsafe version of compressedSize.

ndecompressedSize

public static void ndecompressedSize(long struct,
 long value)

Unsafe version of decompressedSize.

ndecompressionMethod

public static void ndecompressionMethod(long struct,
 long value)

Unsafe version of decompressionMethod.