Class VkDecompressMemoryInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDecompressMemoryInfoEXT>

org.lwjgl.vulkan.VkDecompressMemoryInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDecompressMemoryInfoEXT
extends Struct<VkDecompressMemoryInfoEXT>
implements NativeResource

struct VkDecompressMemoryInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkMemoryDecompressionMethodFlagsEXT decompressionMethod;
    uint32_t regionCount;
    VkDecompressMemoryRegionEXT const * pRegions;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDecompressMemoryInfoEXT.Buffer	An array of VkDecompressMemoryInfoEXT 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	DECOMPRESSIONMETHOD	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PREGIONS	The struct member offsets.
static final int	REGIONCOUNT	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDecompressMemoryInfoEXT	calloc()	Returns a new VkDecompressMemoryInfoEXT instance allocated with memCalloc.
static VkDecompressMemoryInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated with memCalloc.
static VkDecompressMemoryInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDecompressMemoryInfoEXT	calloc(MemoryStack stack)	Returns a new VkDecompressMemoryInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDecompressMemoryInfoEXT	create()	Returns a new VkDecompressMemoryInfoEXT instance allocated with BufferUtils.
static VkDecompressMemoryInfoEXT.Buffer	create(int capacity)	Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated with BufferUtils.
static VkDecompressMemoryInfoEXT	create(long address)	Returns a new VkDecompressMemoryInfoEXT instance for the specified memory address.
static VkDecompressMemoryInfoEXT.Buffer	create(long address, int capacity)	Create a VkDecompressMemoryInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDecompressMemoryInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDecompressMemoryInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	decompressionMethod()
VkDecompressMemoryInfoEXT	decompressionMethod(long value)	Sets the specified value to the decompressionMethod field.
static VkDecompressMemoryInfoEXT	malloc()	Returns a new VkDecompressMemoryInfoEXT instance allocated with memAlloc.
static VkDecompressMemoryInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated with memAlloc.
static VkDecompressMemoryInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDecompressMemoryInfoEXT	malloc(MemoryStack stack)	Returns a new VkDecompressMemoryInfoEXT instance allocated on the specified MemoryStack.
static long	ndecompressionMethod(long struct)	Unsafe version of decompressionMethod().
static void	ndecompressionMethod(long struct, long value)	Unsafe version of decompressionMethod.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkDecompressMemoryRegionEXT.Buffer	npRegions(long struct)	Unsafe version of pRegions().
static void	npRegions(long struct, VkDecompressMemoryRegionEXT.Buffer value)	Unsafe version of pRegions.
static int	nregionCount(long struct)	Unsafe version of regionCount().
static void	nregionCount(long struct, int value)	Sets the specified value to the regionCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkDecompressMemoryInfoEXT	pNext(long value)	Sets the specified value to the pNext field.
VkDecompressMemoryRegionEXT.Buffer	pRegions()
VkDecompressMemoryInfoEXT	pRegions(VkDecompressMemoryRegionEXT.Buffer value)	Sets the address of the specified VkDecompressMemoryRegionEXT.Buffer to the pRegions field.
int	regionCount()
VkDecompressMemoryInfoEXT	set(int sType, long pNext, long decompressionMethod, VkDecompressMemoryRegionEXT.Buffer pRegions)	Initializes this struct with the specified values.
VkDecompressMemoryInfoEXT	set(VkDecompressMemoryInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDecompressMemoryInfoEXT	sType(int value)	Sets the specified value to the sType field.
VkDecompressMemoryInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DECOMPRESS_MEMORY_INFO_EXT value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

DECOMPRESSIONMETHOD

public static final int DECOMPRESSIONMETHOD

The struct member offsets.

REGIONCOUNT

public static final int REGIONCOUNT

The struct member offsets.

PREGIONS

public static final int PREGIONS

The struct member offsets.

Constructor Details

VkDecompressMemoryInfoEXT

public VkDecompressMemoryInfoEXT(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

decompressionMethod

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

Returns:

the value of the decompressionMethod field.

regionCount

@NativeType("uint32_t")
public int regionCount()

Returns:

the value of the regionCount field.

pRegions

@NativeType("VkDecompressMemoryRegionEXT const *")
public VkDecompressMemoryRegionEXT.Buffer pRegions()

Returns:

a VkDecompressMemoryRegionEXT.Buffer view of the struct array pointed to by the pRegions field.

sType

public VkDecompressMemoryInfoEXT sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkDecompressMemoryInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DECOMPRESS_MEMORY_INFO_EXT value to the sType field.

pNext

public VkDecompressMemoryInfoEXT pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

decompressionMethod

public VkDecompressMemoryInfoEXT decompressionMethod(@NativeType("VkMemoryDecompressionMethodFlagsEXT")
 long value)

Sets the specified value to the decompressionMethod field.

pRegions

public VkDecompressMemoryInfoEXT pRegions(@NativeType("VkDecompressMemoryRegionEXT const *")
 VkDecompressMemoryRegionEXT.Buffer value)

Sets the address of the specified VkDecompressMemoryRegionEXT.Buffer to the pRegions field.

set

public VkDecompressMemoryInfoEXT set(int sType,
 long pNext,
 long decompressionMethod,
 VkDecompressMemoryRegionEXT.Buffer pRegions)

Initializes this struct with the specified values.

set

public VkDecompressMemoryInfoEXT set(VkDecompressMemoryInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDecompressMemoryInfoEXT malloc()

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

calloc

public static VkDecompressMemoryInfoEXT calloc()

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

create

public static VkDecompressMemoryInfoEXT create()

Returns a new VkDecompressMemoryInfoEXT instance allocated with BufferUtils.

create

public static VkDecompressMemoryInfoEXT create(long address)

Returns a new VkDecompressMemoryInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDecompressMemoryInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDecompressMemoryInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDecompressMemoryInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDecompressMemoryInfoEXT.Buffer create(int capacity)

Returns a new VkDecompressMemoryInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDecompressMemoryInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDecompressMemoryInfoEXT malloc(MemoryStack stack)

Returns a new VkDecompressMemoryInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDecompressMemoryInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndecompressionMethod

public static long ndecompressionMethod(long struct)

Unsafe version of decompressionMethod().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

public static VkDecompressMemoryRegionEXT.Buffer npRegions(long struct)

Unsafe version of pRegions().

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.

ndecompressionMethod

public static void ndecompressionMethod(long struct,
 long value)

Unsafe version of decompressionMethod.

nregionCount

public static void nregionCount(long struct,
 int value)

Sets the specified value to the regionCount field of the specified struct.

npRegions

public static void npRegions(long struct,
 VkDecompressMemoryRegionEXT.Buffer value)

Unsafe version of pRegions.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate