Package org.lwjgl.vulkan

Class VkSparseImageMemoryRequirements2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageMemoryRequirements2>

org.lwjgl.vulkan.VkSparseImageMemoryRequirements2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkSparseImageMemoryRequirements2KHR

public class VkSparseImageMemoryRequirements2
extends Struct<VkSparseImageMemoryRequirements2>
implements NativeResource

(None).

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SPARSE_IMAGE_MEMORY_REQUIREMENTS_2
• pNext must be NULL

See Also

VkSparseImageMemoryRequirements, GetDeviceImageSparseMemoryRequirements, GetDeviceImageSparseMemoryRequirementsKHR, GetImageSparseMemoryRequirements2, GetImageSparseMemoryRequirements2KHR

Layout

 struct VkSparseImageMemoryRequirements2 {
     VkStructureType sType();
     void * pNext();
     VkSparseImageMemoryRequirements memoryRequirements();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MEMORYREQUIREMENTS	The struct member offsets.
static final int	PNEXT	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSparseImageMemoryRequirements2	calloc()	Returns a new VkSparseImageMemoryRequirements2 instance allocated with memCalloc.
static VkSparseImageMemoryRequirements2.Buffer	calloc(int capacity)	Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated with memCalloc.
static VkSparseImageMemoryRequirements2.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements2	calloc(MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements2	callocStack()	Deprecated.
static VkSparseImageMemoryRequirements2.Buffer	callocStack(int capacity)	Deprecated.
static VkSparseImageMemoryRequirements2.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSparseImageMemoryRequirements2	callocStack(MemoryStack stack)	Deprecated.
static VkSparseImageMemoryRequirements2	create()	Returns a new VkSparseImageMemoryRequirements2 instance allocated with BufferUtils.
static VkSparseImageMemoryRequirements2.Buffer	create(int capacity)	Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated with BufferUtils.
static VkSparseImageMemoryRequirements2	create(long address)	Returns a new VkSparseImageMemoryRequirements2 instance for the specified memory address.
static VkSparseImageMemoryRequirements2.Buffer	create(long address, int capacity)	Create a VkSparseImageMemoryRequirements2.Buffer instance at the specified memory.
static VkSparseImageMemoryRequirements2	createSafe(long address)	Like create, but returns null if address is NULL.
static VkSparseImageMemoryRequirements2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSparseImageMemoryRequirements2	malloc()	Returns a new VkSparseImageMemoryRequirements2 instance allocated with memAlloc.
static VkSparseImageMemoryRequirements2.Buffer	malloc(int capacity)	Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated with memAlloc.
static VkSparseImageMemoryRequirements2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageMemoryRequirements2	malloc(MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements2 instance allocated on the specified MemoryStack.
static VkSparseImageMemoryRequirements2	mallocStack()	Deprecated.
static VkSparseImageMemoryRequirements2.Buffer	mallocStack(int capacity)	Deprecated.
static VkSparseImageMemoryRequirements2.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSparseImageMemoryRequirements2	mallocStack(MemoryStack stack)	Deprecated.
VkSparseImageMemoryRequirements	memoryRequirements()	a VkSparseImageMemoryRequirements structure describing the memory requirements of the sparse image.
static VkSparseImageMemoryRequirements	nmemoryRequirements(long struct)	Unsafe version of memoryRequirements().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSparseImageMemoryRequirements2	pNext(long value)	Sets the specified value to the pNext() field.
VkSparseImageMemoryRequirements2	set(int sType, long pNext)	Initializes this struct with the specified values.
VkSparseImageMemoryRequirements2	set(VkSparseImageMemoryRequirements2 src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkSparseImageMemoryRequirements2	sType(int value)	Sets the specified value to the sType() field.
VkSparseImageMemoryRequirements2	sType$Default()	Sets the STRUCTURE_TYPE_SPARSE_IMAGE_MEMORY_REQUIREMENTS_2 value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

MEMORYREQUIREMENTS

public static final int MEMORYREQUIREMENTS

The struct member offsets.

Constructor Details

VkSparseImageMemoryRequirements2

public VkSparseImageMemoryRequirements2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memoryRequirements

public VkSparseImageMemoryRequirements memoryRequirements()

a VkSparseImageMemoryRequirements structure describing the memory requirements of the sparse image.

sType

public VkSparseImageMemoryRequirements2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSparseImageMemoryRequirements2 sType$Default()

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_MEMORY_REQUIREMENTS_2 value to the sType() field.

pNext

public VkSparseImageMemoryRequirements2 pNext(long value)

Sets the specified value to the pNext() field.

set

public VkSparseImageMemoryRequirements2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSparseImageMemoryRequirements2 set(VkSparseImageMemoryRequirements2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSparseImageMemoryRequirements2 malloc()

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

calloc

public static VkSparseImageMemoryRequirements2 calloc()

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

create

public static VkSparseImageMemoryRequirements2 create()

Returns a new VkSparseImageMemoryRequirements2 instance allocated with BufferUtils.

create

public static VkSparseImageMemoryRequirements2 create(long address)

Returns a new VkSparseImageMemoryRequirements2 instance for the specified memory address.

createSafe

@Nullable
public static VkSparseImageMemoryRequirements2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryRequirements2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageMemoryRequirements2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageMemoryRequirements2.Buffer create(int capacity)

Returns a new VkSparseImageMemoryRequirements2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageMemoryRequirements2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements2 mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements2 callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements2 mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements2 callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements2.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements2.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements2.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements2.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkSparseImageMemoryRequirements2 malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryRequirements2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageMemoryRequirements2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemoryRequirements

public static VkSparseImageMemoryRequirements nmemoryRequirements(long struct)

Unsafe version of memoryRequirements().

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.