Class VkSparseImageMemoryRequirements

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageMemoryRequirements>

org.lwjgl.vulkan.VkSparseImageMemoryRequirements

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSparseImageMemoryRequirements
extends Struct<VkSparseImageMemoryRequirements>
implements NativeResource

struct VkSparseImageMemoryRequirements {
    VkSparseImageFormatProperties formatProperties;
    uint32_t imageMipTailFirstLod;
    VkDeviceSize imageMipTailSize;
    VkDeviceSize imageMipTailOffset;
    VkDeviceSize imageMipTailStride;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSparseImageMemoryRequirements.Buffer	An array of VkSparseImageMemoryRequirements 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	FORMATPROPERTIES	The struct member offsets.
static final int	IMAGEMIPTAILFIRSTLOD	The struct member offsets.
static final int	IMAGEMIPTAILOFFSET	The struct member offsets.
static final int	IMAGEMIPTAILSIZE	The struct member offsets.
static final int	IMAGEMIPTAILSTRIDE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSparseImageMemoryRequirements	calloc()	Returns a new VkSparseImageMemoryRequirements instance allocated with memCalloc.
static VkSparseImageMemoryRequirements.Buffer	calloc(int capacity)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with memCalloc.
static VkSparseImageMemoryRequirements.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements	calloc(MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements	create()	Returns a new VkSparseImageMemoryRequirements instance allocated with BufferUtils.
static VkSparseImageMemoryRequirements.Buffer	create(int capacity)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with BufferUtils.
static VkSparseImageMemoryRequirements	create(long address)	Returns a new VkSparseImageMemoryRequirements instance for the specified memory address.
static VkSparseImageMemoryRequirements.Buffer	create(long address, int capacity)	Create a VkSparseImageMemoryRequirements.Buffer instance at the specified memory.
static @Nullable VkSparseImageMemoryRequirements	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSparseImageMemoryRequirements.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkSparseImageFormatProperties	formatProperties()
int	imageMipTailFirstLod()
long	imageMipTailOffset()
long	imageMipTailSize()
long	imageMipTailStride()
static VkSparseImageMemoryRequirements	malloc()	Returns a new VkSparseImageMemoryRequirements instance allocated with memAlloc.
static VkSparseImageMemoryRequirements.Buffer	malloc(int capacity)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with memAlloc.
static VkSparseImageMemoryRequirements.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageMemoryRequirements	malloc(MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.
static VkSparseImageFormatProperties	nformatProperties(long struct)	Unsafe version of formatProperties().
static int	nimageMipTailFirstLod(long struct)	Unsafe version of imageMipTailFirstLod().
static long	nimageMipTailOffset(long struct)	Unsafe version of imageMipTailOffset().
static long	nimageMipTailSize(long struct)	Unsafe version of imageMipTailSize().
static long	nimageMipTailStride(long struct)	Unsafe version of imageMipTailStride().
int	sizeof()	Returns sizeof(struct).

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.

FORMATPROPERTIES

public static final int FORMATPROPERTIES

The struct member offsets.

IMAGEMIPTAILFIRSTLOD

public static final int IMAGEMIPTAILFIRSTLOD

The struct member offsets.

IMAGEMIPTAILSIZE

public static final int IMAGEMIPTAILSIZE

The struct member offsets.

IMAGEMIPTAILOFFSET

public static final int IMAGEMIPTAILOFFSET

The struct member offsets.

IMAGEMIPTAILSTRIDE

public static final int IMAGEMIPTAILSTRIDE

The struct member offsets.

Constructor Details

VkSparseImageMemoryRequirements

public VkSparseImageMemoryRequirements(ByteBuffer container)

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

formatProperties

public VkSparseImageFormatProperties formatProperties()

Returns:

a VkSparseImageFormatProperties view of the formatProperties field.

imageMipTailFirstLod

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

Returns:

the value of the imageMipTailFirstLod field.

imageMipTailSize

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

Returns:

the value of the imageMipTailSize field.

imageMipTailOffset

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

Returns:

the value of the imageMipTailOffset field.

imageMipTailStride

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

Returns:

the value of the imageMipTailStride field.

malloc

public static VkSparseImageMemoryRequirements malloc()

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

calloc

public static VkSparseImageMemoryRequirements calloc()

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

create

public static VkSparseImageMemoryRequirements create()

Returns a new VkSparseImageMemoryRequirements instance allocated with BufferUtils.

create

public static VkSparseImageMemoryRequirements create(long address)

Returns a new VkSparseImageMemoryRequirements instance for the specified memory address.

createSafe

public static @Nullable VkSparseImageMemoryRequirements createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryRequirements.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageMemoryRequirements.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageMemoryRequirements.Buffer create(int capacity)

Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageMemoryRequirements.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryRequirements malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageMemoryRequirements calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nformatProperties

public static VkSparseImageFormatProperties nformatProperties(long struct)

Unsafe version of formatProperties().

nimageMipTailFirstLod

public static int nimageMipTailFirstLod(long struct)

Unsafe version of imageMipTailFirstLod().

nimageMipTailSize

public static long nimageMipTailSize(long struct)

Unsafe version of imageMipTailSize().

nimageMipTailOffset

public static long nimageMipTailOffset(long struct)

Unsafe version of imageMipTailOffset().

nimageMipTailStride

public static long nimageMipTailStride(long struct)

Unsafe version of imageMipTailStride().