Package org.lwjgl.vulkan
Class VkSparseImageMemoryRequirements
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseImageMemoryRequirements
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkSparseImageMemoryRequirements extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes the sparse memory requirements for a group of aspects of an image.
Member documentation
formatProperties
– the format propertiesimageMipTailFirstLod
– the first mip level at which image subresources are included in the mip tail regionimageMipTailSize
– the memory size (in bytes) of the mip tail regionimageMipTailOffset
– he opaque memory offset used withVkSparseImageOpaqueMemoryBindInfo
to bind the mip tail region(s)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)
Layout
struct VkSparseImageMemoryRequirements {
VkSparseImageFormatProperties
formatProperties; uint32_t imageMipTailFirstLod; VkDeviceSize imageMipTailSize; VkDeviceSize imageMipTailOffset; VkDeviceSize imageMipTailStride; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkSparseImageMemoryRequirements.Buffer
An array ofVkSparseImageMemoryRequirements
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkSparseImageMemoryRequirements(java.nio.ByteBuffer container)
Creates aVkSparseImageMemoryRequirements
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkSparseImageMemoryRequirements
calloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemCalloc
.static VkSparseImageMemoryRequirements.Buffer
calloc(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemCalloc
.static VkSparseImageMemoryRequirements
callocStack()
Returns a newVkSparseImageMemoryRequirements
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryRequirements.Buffer
callocStack(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryRequirements.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryRequirements
callocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryRequirements
create()
Returns a newVkSparseImageMemoryRequirements
instance allocated withBufferUtils
.static VkSparseImageMemoryRequirements.Buffer
create(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withBufferUtils
.static VkSparseImageMemoryRequirements
create(long address)
Returns a newVkSparseImageMemoryRequirements
instance for the specified memory address ornull
if the address isNULL
.static VkSparseImageMemoryRequirements.Buffer
create(long address, int capacity)
Create aVkSparseImageMemoryRequirements.Buffer
instance at the specified memory.VkSparseImageFormatProperties
formatProperties()
Returns aVkSparseImageFormatProperties
view of theformatProperties
field.int
imageMipTailFirstLod()
Returns the value of theimageMipTailFirstLod
field.long
imageMipTailOffset()
Returns the value of theimageMipTailOffset
field.long
imageMipTailSize()
Returns the value of theimageMipTailSize
field.long
imageMipTailStride()
Returns the value of theimageMipTailStride
field.static VkSparseImageMemoryRequirements
malloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemAlloc
.static VkSparseImageMemoryRequirements.Buffer
malloc(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemAlloc
.static VkSparseImageMemoryRequirements
mallocStack()
Returns a newVkSparseImageMemoryRequirements
instance allocated on the thread-localMemoryStack
.static VkSparseImageMemoryRequirements.Buffer
mallocStack(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
.static VkSparseImageMemoryRequirements.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseImageMemoryRequirements
mallocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkSparseImageMemoryRequirements
public VkSparseImageMemoryRequirements(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
formatProperties
public VkSparseImageFormatProperties formatProperties()
Returns aVkSparseImageFormatProperties
view of theformatProperties
field.
-
imageMipTailFirstLod
public int imageMipTailFirstLod()
Returns the value of theimageMipTailFirstLod
field.
-
imageMipTailSize
public long imageMipTailSize()
Returns the value of theimageMipTailSize
field.
-
imageMipTailOffset
public long imageMipTailOffset()
Returns the value of theimageMipTailOffset
field.
-
imageMipTailStride
public long imageMipTailStride()
Returns the value of theimageMipTailStride
field.
-
malloc
public static VkSparseImageMemoryRequirements malloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSparseImageMemoryRequirements calloc()
Returns a newVkSparseImageMemoryRequirements
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSparseImageMemoryRequirements create()
Returns a newVkSparseImageMemoryRequirements
instance allocated withBufferUtils
.
-
create
public static VkSparseImageMemoryRequirements create(long address)
Returns a newVkSparseImageMemoryRequirements
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkSparseImageMemoryRequirements.Buffer malloc(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSparseImageMemoryRequirements.Buffer calloc(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageMemoryRequirements.Buffer create(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageMemoryRequirements.Buffer create(long address, int capacity)
Create aVkSparseImageMemoryRequirements.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkSparseImageMemoryRequirements mallocStack()
Returns a newVkSparseImageMemoryRequirements
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSparseImageMemoryRequirements callocStack()
Returns a newVkSparseImageMemoryRequirements
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSparseImageMemoryRequirements mallocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseImageMemoryRequirements callocStack(MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkSparseImageMemoryRequirements.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-