Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSparseImageMemoryRequirements

extends Struct<VkSparseImageMemoryRequirements>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FORMATPROPERTIES

The struct member offsets.

public static final int
IMAGEMIPTAILFIRSTLOD

The struct member offsets.

public static final int
IMAGEMIPTAILOFFSET

The struct member offsets.

public static final int
IMAGEMIPTAILSIZE

The struct member offsets.

public static final int
IMAGEMIPTAILSTRIDE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkSparseImageMemoryRequirements(ByteBuffer container)

Creates a VkSparseImageMemoryRequirements instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSparseImageMemoryRequirements
calloc()

Returns a new VkSparseImageMemoryRequirements instance allocated with memCalloc.

public static VkSparseImageMemoryRequirements.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with memCalloc.

public static VkSparseImageMemoryRequirements
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryRequirements.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryRequirements
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSparseImageMemoryRequirements
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSparseImageMemoryRequirements
create()

Returns a new VkSparseImageMemoryRequirements instance allocated with BufferUtils.

public static VkSparseImageMemoryRequirements
create(long address)

Returns a new VkSparseImageMemoryRequirements instance for the specified memory address.

public static VkSparseImageMemoryRequirements.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with BufferUtils.

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

Create a VkSparseImageMemoryRequirements.Buffer instance at the specified memory.

public static VkSparseImageMemoryRequirements
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkSparseImageFormatProperties
formatProperties()

a VkSparseImageFormatProperties structure specifying properties of the image format.

public int
imageMipTailFirstLod()

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

public long
imageMipTailOffset()

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

public long
imageMipTailSize()

the memory size (in bytes) of the mip tail region.

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

public static VkSparseImageMemoryRequirements
malloc()

Returns a new VkSparseImageMemoryRequirements instance allocated with memAlloc.

public static VkSparseImageMemoryRequirements.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with memAlloc.

public static VkSparseImageMemoryRequirements
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.

public static VkSparseImageMemoryRequirements.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryRequirements
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryRequirements.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties
nformatProperties(long struct)

Unsafe version of formatProperties.

public static int
nimageMipTailFirstLod(long struct)

Unsafe version of imageMipTailFirstLod.

public static long
nimageMipTailOffset(long struct)

Unsafe version of imageMipTailOffset.

public static long
nimageMipTailSize(long struct)

Unsafe version of imageMipTailSize.

public static long
nimageMipTailStride(long struct)

Unsafe version of imageMipTailStride.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FORMATPROPERTIESback to summary
public static final int FORMATPROPERTIES

The struct member offsets.

IMAGEMIPTAILFIRSTLODback to summary
public static final int IMAGEMIPTAILFIRSTLOD

The struct member offsets.

IMAGEMIPTAILOFFSETback to summary
public static final int IMAGEMIPTAILOFFSET

The struct member offsets.

IMAGEMIPTAILSIZEback to summary
public static final int IMAGEMIPTAILSIZE

The struct member offsets.

IMAGEMIPTAILSTRIDEback to summary
public static final int IMAGEMIPTAILSTRIDE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkSparseImageMemoryRequirementsback to summary
protected VkSparseImageMemoryRequirements(long address, ByteBuffer container)
VkSparseImageMemoryRequirementsback to summary
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 Detail

callocback to summary
public static VkSparseImageMemoryRequirements calloc()

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

callocback to summary
public static VkSparseImageMemoryRequirements.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSparseImageMemoryRequirements callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryRequirements callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkSparseImageMemoryRequirements create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSparseImageMemoryRequirements create()

Returns a new VkSparseImageMemoryRequirements instance allocated with BufferUtils.

createback to summary
public static VkSparseImageMemoryRequirements create(long address)

Returns a new VkSparseImageMemoryRequirements instance for the specified memory address.

createback to summary
public static VkSparseImageMemoryRequirements.Buffer create(int capacity)

Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSparseImageMemoryRequirements.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSparseImageMemoryRequirements createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSparseImageMemoryRequirements.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatPropertiesback to summary
public VkSparseImageFormatProperties formatProperties()

a VkSparseImageFormatProperties structure specifying properties of the image format.

imageMipTailFirstLodback to summary
public int imageMipTailFirstLod()

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

Annotations
@NativeType:uint32_t
imageMipTailOffsetback to summary
public long imageMipTailOffset()

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

Annotations
@NativeType:VkDeviceSize
imageMipTailSizeback to summary
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.

Annotations
@NativeType:VkDeviceSize
imageMipTailStrideback to summary
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).

Annotations
@NativeType:VkDeviceSize
mallocback to summary
public static VkSparseImageMemoryRequirements malloc()

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

mallocback to summary
public static VkSparseImageMemoryRequirements.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSparseImageMemoryRequirements malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSparseImageMemoryRequirements mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryRequirements mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nformatPropertiesback to summary
public static VkSparseImageFormatProperties nformatProperties(long struct)

Unsafe version of formatProperties.

nimageMipTailFirstLodback to summary
public static int nimageMipTailFirstLod(long struct)

Unsafe version of imageMipTailFirstLod.

nimageMipTailOffsetback to summary
public static long nimageMipTailOffset(long struct)

Unsafe version of imageMipTailOffset.

nimageMipTailSizeback to summary
public static long nimageMipTailSize(long struct)

Unsafe version of imageMipTailSize.

nimageMipTailStrideback to summary
public static long nimageMipTailStride(long struct)

Unsafe version of imageMipTailStride.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkSparseImageMemoryRequirements.Buffer

extends StructBuffer<VkSparseImageMemoryRequirements, VkSparseImageMemoryRequirements.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSparseImageMemoryRequirements structs.

Field Summary

Modifier and TypeField and Description
private static final VkSparseImageMemoryRequirements

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSparseImageMemoryRequirements.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public VkSparseImageFormatProperties
protected VkSparseImageMemoryRequirements
public int
public long
public long
public long
protected VkSparseImageMemoryRequirements.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSparseImageMemoryRequirements ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSparseImageMemoryRequirements.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSparseImageMemoryRequirements#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

formatPropertiesback to summary
public VkSparseImageFormatProperties formatProperties()
Returns:VkSparseImageFormatProperties

a VkSparseImageFormatProperties view of the VkSparseImageMemoryRequirements#formatProperties field.

getElementFactoryback to summary
protected VkSparseImageMemoryRequirements getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
imageMipTailFirstLodback to summary
public int imageMipTailFirstLod()
Returns:int

the value of the VkSparseImageMemoryRequirements#imageMipTailFirstLod field.

Annotations
@NativeType:uint32_t
imageMipTailOffsetback to summary
public long imageMipTailOffset()
Returns:long

the value of the VkSparseImageMemoryRequirements#imageMipTailOffset field.

Annotations
@NativeType:VkDeviceSize
imageMipTailSizeback to summary
public long imageMipTailSize()
Returns:long

the value of the VkSparseImageMemoryRequirements#imageMipTailSize field.

Annotations
@NativeType:VkDeviceSize
imageMipTailStrideback to summary
public long imageMipTailStride()
Returns:long

the value of the VkSparseImageMemoryRequirements#imageMipTailStride field.

Annotations
@NativeType:VkDeviceSize
selfback to summary
protected VkSparseImageMemoryRequirements.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override