Package org.lwjgl.vulkan

Class VkImageSparseMemoryRequirementsInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkImageSparseMemoryRequirementsInfo2

org.lwjgl.vulkan.VkImageSparseMemoryRequirementsInfo2KHR

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer

public class VkImageSparseMemoryRequirementsInfo2KHR
extends VkImageSparseMemoryRequirementsInfo2

See VkImageSparseMemoryRequirementsInfo2.

Layout

 struct VkImageSparseMemoryRequirementsInfo2KHR {
     VkStructureType sType;
     void const * pNext;
     VkImage image;
 }

Nested Class Summary

Nested Classes

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

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

Pointer.Default

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

Fields inherited from class org.lwjgl.vulkan.VkImageSparseMemoryRequirementsInfo2

ALIGNOF, IMAGE, PNEXT, SIZEOF, STYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageSparseMemoryRequirementsInfo2KHR	calloc()	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated with memCalloc.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	calloc(int capacity)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated with memCalloc.
static VkImageSparseMemoryRequirementsInfo2KHR	callocStack()	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	callocStack(int capacity)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	callocStack(int capacity, MemoryStack stack)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSparseMemoryRequirementsInfo2KHR	callocStack(MemoryStack stack)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSparseMemoryRequirementsInfo2KHR	create()	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated with BufferUtils.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	create(int capacity)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated with BufferUtils.
static VkImageSparseMemoryRequirementsInfo2KHR	create(long address)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance for the specified memory address.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	create(long address, int capacity)	Create a VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance at the specified memory.
static VkImageSparseMemoryRequirementsInfo2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkImageSparseMemoryRequirementsInfo2KHR	image(long value)	Sets the specified value to the image field.
static VkImageSparseMemoryRequirementsInfo2KHR	malloc()	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated with memAlloc.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	malloc(int capacity)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated with memAlloc.
static VkImageSparseMemoryRequirementsInfo2KHR	mallocStack()	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the thread-local MemoryStack.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	mallocStack(int capacity)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the thread-local MemoryStack.
static VkImageSparseMemoryRequirementsInfo2KHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the specified MemoryStack.
static VkImageSparseMemoryRequirementsInfo2KHR	mallocStack(MemoryStack stack)	Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the specified MemoryStack.
VkImageSparseMemoryRequirementsInfo2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkImageSparseMemoryRequirementsInfo2KHR	set(int sType, long pNext, long image)	Initializes this struct with the specified values.
VkImageSparseMemoryRequirementsInfo2KHR	set(VkImageSparseMemoryRequirementsInfo2KHR src)	Copies the specified struct data to this struct.
VkImageSparseMemoryRequirementsInfo2KHR	sType(int value)	Sets the specified value to the sType field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Methods inherited from class org.lwjgl.vulkan.VkImageSparseMemoryRequirementsInfo2

image, nimage, nimage, npNext, npNext, nsType, nsType, pNext, set, sizeof, sType

Constructor Detail

VkImageSparseMemoryRequirementsInfo2KHR

public VkImageSparseMemoryRequirementsInfo2KHR(java.nio.ByteBuffer container)

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

sType

public VkImageSparseMemoryRequirementsInfo2KHR sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkImageSparseMemoryRequirementsInfo2

pNext

public VkImageSparseMemoryRequirementsInfo2KHR pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkImageSparseMemoryRequirementsInfo2

image

public VkImageSparseMemoryRequirementsInfo2KHR image(long value)

Sets the specified value to the image field.

Overrides:

image in class VkImageSparseMemoryRequirementsInfo2

set

public VkImageSparseMemoryRequirementsInfo2KHR set(int sType,
                                                   long pNext,
                                                   long image)

Initializes this struct with the specified values.

Overrides:

set in class VkImageSparseMemoryRequirementsInfo2

set

public VkImageSparseMemoryRequirementsInfo2KHR set(VkImageSparseMemoryRequirementsInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageSparseMemoryRequirementsInfo2KHR malloc()

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

calloc

public static VkImageSparseMemoryRequirementsInfo2KHR calloc()

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

create

public static VkImageSparseMemoryRequirementsInfo2KHR create()

Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated with BufferUtils.

create

public static VkImageSparseMemoryRequirementsInfo2KHR create(long address)

Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance for the specified memory address.

createSafe

@Nullable
public static VkImageSparseMemoryRequirementsInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer create(int capacity)

Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

public static VkImageSparseMemoryRequirementsInfo2KHR mallocStack()

Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the thread-local MemoryStack.

callocStack

public static VkImageSparseMemoryRequirementsInfo2KHR callocStack()

Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack

public static VkImageSparseMemoryRequirementsInfo2KHR mallocStack(MemoryStack stack)

Returns a new VkImageSparseMemoryRequirementsInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack

public static VkImageSparseMemoryRequirementsInfo2KHR callocStack(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

mallocStack

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer mallocStack(int capacity)

Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer callocStack(int capacity)

Returns a new VkImageSparseMemoryRequirementsInfo2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer mallocStack(int capacity,
                                                                         MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

callocStack

public static VkImageSparseMemoryRequirementsInfo2KHR.Buffer callocStack(int capacity,
                                                                         MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity