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 Specification
Describes the sparse memory requirements for a group of aspects of an image.

Member documentation
- formatProperties – the format properties
- imageMipTailFirstLod – the first mip level at which image subresources are included in the mip tail region
- imageMipTailSize – the memory size (in bytes) of the mip tail region
- imageMipTailOffset – he opaque memory offset used with VkSparseImageOpaqueMemoryBindInfo to bind the mip tail region(s)
- 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)
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 of VkSparseImageMemoryRequirements 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 a `VkSparseImageMemoryRequirements` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkSparseImageMemoryRequirements` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryRequirements.Buffer`	`callocStack(int capacity)` Returns a new `VkSparseImageMemoryRequirements.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryRequirements.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkSparseImageMemoryRequirements.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryRequirements`	`callocStack(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 or `null` if the address is `NULL`.
`static VkSparseImageMemoryRequirements.Buffer`	`create(long address, int capacity)` Create a `VkSparseImageMemoryRequirements.Buffer` instance at the specified memory.
`VkSparseImageFormatProperties`	`formatProperties()` Returns a `VkSparseImageFormatProperties` view of the `formatProperties` field.
`int`	`imageMipTailFirstLod()` Returns the value of the `imageMipTailFirstLod` field.
`long`	`imageMipTailOffset()` Returns the value of the `imageMipTailOffset` field.
`long`	`imageMipTailSize()` Returns the value of the `imageMipTailSize` field.
`long`	`imageMipTailStride()` Returns the value of the `imageMipTailStride` field.
`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`	`mallocStack()` Returns a new `VkSparseImageMemoryRequirements` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryRequirements.Buffer`	`mallocStack(int capacity)` Returns a new `VkSparseImageMemoryRequirements.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryRequirements.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkSparseImageMemoryRequirements.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseImageMemoryRequirements`	`mallocStack(MemoryStack stack)` Returns a new `VkSparseImageMemoryRequirements` instance allocated on the specified `MemoryStack`.
`int`	`sizeof()` Returns the `sizeof(struct)`.

Methods inherited from class org.lwjgl.system.Struct
clear, free

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkSparseImageMemoryRequirements
```
public VkSparseImageMemoryRequirements(java.nio.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
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - formatProperties
```
public VkSparseImageFormatProperties formatProperties()
```
    Returns a VkSparseImageFormatProperties view of the formatProperties field.
  - imageMipTailFirstLod
```
public int imageMipTailFirstLod()
```
    Returns the value of the imageMipTailFirstLod field.
  - imageMipTailSize
```
public long imageMipTailSize()
```
    Returns the value of the imageMipTailSize field.
  - imageMipTailOffset
```
public long imageMipTailOffset()
```
    Returns the value of the imageMipTailOffset field.
  - imageMipTailStride
```
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 or null if the 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
  - mallocStack
```
public static VkSparseImageMemoryRequirements mallocStack()
```
    Returns a new VkSparseImageMemoryRequirements instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSparseImageMemoryRequirements callocStack()
```
    Returns a new VkSparseImageMemoryRequirements instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSparseImageMemoryRequirements mallocStack(MemoryStack stack)
```
    Returns a new VkSparseImageMemoryRequirements instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSparseImageMemoryRequirements callocStack(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
  - mallocStack
```
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity)
```
    Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity)
```
    Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSparseImageMemoryRequirements.Buffer mallocStack(int capacity,
                                                                 MemoryStack stack)
```
    Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryRequirements.Buffer callocStack(int capacity,
                                                                 MemoryStack stack)
```
    Returns a new VkSparseImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

Class VkSparseImageMemoryRequirements

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

Constructor Detail

VkSparseImageMemoryRequirements

Method Detail

sizeof

formatProperties

imageMipTailFirstLod

imageMipTailSize

imageMipTailOffset

imageMipTailStride

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack