Package org.lwjgl.vulkan

Class VkSparseImageMemoryRequirements

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageMemoryRequirements>

org.lwjgl.vulkan.VkSparseImageMemoryRequirements

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkSparseImageMemoryRequirements
extends org.lwjgl.system.Struct<VkSparseImageMemoryRequirements>
implements org.lwjgl.system.NativeResource

Structure specifying sparse image memory requirements.

See Also

VkSparseImageFormatProperties, VkSparseImageMemoryRequirements2, GetImageSparseMemoryRequirements

Layout

 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 org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.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 org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryRequirements	callocStack()	Deprecated.
static VkSparseImageMemoryRequirements.Buffer	callocStack(int capacity)	Deprecated.
static VkSparseImageMemoryRequirements.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseImageMemoryRequirements	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()	a VkSparseImageFormatProperties structure specifying properties of the image format.
int	imageMipTailFirstLod()	the first mip level at which image subresources are included in the mip tail region.
long	imageMipTailOffset()	the opaque memory offset used with VkSparseImageOpaqueMemoryBindInfo to bind the mip tail region(s).
long	imageMipTailSize()	the memory size (in bytes) of the mip tail region.
long	imageMipTailStride()	the offset stride between each array-layer’s mip tail, if formatProperties.flags does not contain SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT (otherwise the value is undefined).
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, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageMemoryRequirements	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.
static VkSparseImageMemoryRequirements	mallocStack()	Deprecated.
static VkSparseImageMemoryRequirements.Buffer	mallocStack(int capacity)	Deprecated.
static VkSparseImageMemoryRequirements.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseImageMemoryRequirements	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkSparseImageMemoryRequirements>

formatProperties

public VkSparseImageFormatProperties formatProperties()

a VkSparseImageFormatProperties structure specifying properties of the image format.

imageMipTailFirstLod

public int imageMipTailFirstLod()

the first mip level at which image subresources are included in the mip tail region.

imageMipTailSize

public long imageMipTailSize()

the memory size (in bytes) of the mip tail region. If formatProperties.flags contains SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT, this is the size of the whole mip tail, otherwise this is the size of the mip tail of a single array layer. This value is guaranteed to be a multiple of the sparse block size in bytes.

imageMipTailOffset

public long imageMipTailOffset()

the opaque memory offset used with VkSparseImageOpaqueMemoryBindInfo to bind the mip tail region(s).

imageMipTailStride

public long imageMipTailStride()

the offset stride between each array-layer’s mip tail, if formatProperties.flags does not contain SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT (otherwise the value is undefined).

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.

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkSparseImageMemoryRequirements malloc(org.lwjgl.system.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(org.lwjgl.system.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,
 org.lwjgl.system.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,
 org.lwjgl.system.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().