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
,NativeResource
,Pointer
public class VkSparseImageMemoryRequirements
extends Struct<VkSparseImageMemoryRequirements>
implements 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
Modifier and TypeClassDescriptionstatic class
An array ofVkSparseImageMemoryRequirements
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
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
ConstructorDescriptionVkSparseImageMemoryRequirements
(ByteBuffer container) Creates aVkSparseImageMemoryRequirements
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkSparseImageMemoryRequirements
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkSparseImageMemoryRequirements
instance for the specified memory address.create
(long address, int capacity) Create aVkSparseImageMemoryRequirements.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) aVkSparseImageFormatProperties
structure specifying properties of the image format.int
the first mip level at which image subresources are included in the mip tail region.long
the opaque memory offset used withVkSparseImageOpaqueMemoryBindInfo
to bind the mip tail region(s).long
the memory size (in bytes) of the mip tail region.long
the offset stride between each array-layer’s mip tail, ifformatProperties.flags
does not containSPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT
(otherwise the value is undefined).malloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.nformatProperties
(long struct) Unsafe version offormatProperties()
.static int
nimageMipTailFirstLod
(long struct) Unsafe version ofimageMipTailFirstLod()
.static long
nimageMipTailOffset
(long struct) Unsafe version ofimageMipTailOffset()
.static long
nimageMipTailSize
(long struct) Unsafe version ofimageMipTailSize()
.static long
nimageMipTailStride
(long struct) Unsafe version ofimageMipTailStride()
.int
sizeof()
Returnssizeof(struct)
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
FORMATPROPERTIES
public static final int FORMATPROPERTIESThe struct member offsets. -
IMAGEMIPTAILFIRSTLOD
public static final int IMAGEMIPTAILFIRSTLODThe struct member offsets. -
IMAGEMIPTAILSIZE
public static final int IMAGEMIPTAILSIZEThe struct member offsets. -
IMAGEMIPTAILOFFSET
public static final int IMAGEMIPTAILOFFSETThe struct member offsets. -
IMAGEMIPTAILSTRIDE
public static final int IMAGEMIPTAILSTRIDEThe struct member offsets.
-
-
Constructor Details
-
VkSparseImageMemoryRequirements
Creates aVkSparseImageMemoryRequirements
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSparseImageMemoryRequirements>
-
formatProperties
aVkSparseImageFormatProperties
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. IfformatProperties.flags
containsSPARSE_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 withVkSparseImageOpaqueMemoryBindInfo
to bind the mip tail region(s). -
imageMipTailStride
public long imageMipTailStride()the offset stride between each array-layer’s mip tail, ifformatProperties.flags
does not containSPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT
(otherwise the value is undefined). -
malloc
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSparseImageMemoryRequirements
instance allocated withBufferUtils
. -
create
Returns a newVkSparseImageMemoryRequirements
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSparseImageMemoryRequirements.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSparseImageMemoryRequirements.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nformatProperties
Unsafe version offormatProperties()
. -
nimageMipTailFirstLod
public static int nimageMipTailFirstLod(long struct) Unsafe version ofimageMipTailFirstLod()
. -
nimageMipTailSize
public static long nimageMipTailSize(long struct) Unsafe version ofimageMipTailSize()
. -
nimageMipTailOffset
public static long nimageMipTailOffset(long struct) Unsafe version ofimageMipTailOffset()
. -
nimageMipTailStride
public static long nimageMipTailStride(long struct) Unsafe version ofimageMipTailStride()
.
-