VkSparseImageMemoryRequirements (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSparseImageMemoryRequirements

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSparseImageMemoryRequirements
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying sparse image memory requirements.
Member documentation
- formatProperties – formatProperties.aspectMask is the set of aspects of the image that this sparse memory requirement applies to. This will usually have a single aspect specified. However, depth/stencil images may have depth and stencil data interleaved in the same sparse block, in which case both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT would be present.
  formatProperties.imageGranularity describes the dimensions of a single bindable sparse image block in texel units. For aspect IMAGE_ASPECT_METADATA_BIT, all dimensions will be zero. All metadata is located in the mip tail region.
  
  formatProperties.flags is a bitmask of VkSparseImageFormatFlagBits:
  - If SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT is set the image uses a single mip tail region for all array layers.
  - If SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT is set the dimensions of mip levels must be integer multiples of the corresponding dimensions of the sparse image block for levels not located in the mip tail.
  - If SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT is set the image uses non-standard sparse image block dimensions. The formatProperties.imageGranularity values do not match the standard sparse image block dimension corresponding to the image’s format.
- 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. 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 – the 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
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkSparseImageMemoryRequirements.Buffer` An array of `VkSparseImageMemoryRequirements` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FORMATPROPERTIES` The struct member offsets.
`static int`	`IMAGEMIPTAILFIRSTLOD` The struct member offsets.
`static int`	`IMAGEMIPTAILOFFSET` The struct member offsets.
`static int`	`IMAGEMIPTAILSIZE` The struct member offsets.
`static int`	`IMAGEMIPTAILSTRIDE` The struct member offsets.
`static 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 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, 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`	`callocStack(org.lwjgl.system.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.
`static VkSparseImageMemoryRequirements.Buffer`	`create(long address, int capacity)` Create a `VkSparseImageMemoryRequirements.Buffer` instance at the specified memory.
`static VkSparseImageMemoryRequirements`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSparseImageMemoryRequirements.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryRequirements.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseImageMemoryRequirements`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryRequirements` instance allocated on the specified `MemoryStack`.
`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

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 Detail
  - 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 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - createSafe
```
@Nullable
public static 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
```
@Nullable
public static VkSparseImageMemoryRequirements.Buffer createSafe(long address,
                                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(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
  - 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,
                                                                 org.lwjgl.system.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,
                                                                 org.lwjgl.system.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
  - 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().

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

ALIGNOF

FORMATPROPERTIES

IMAGEMIPTAILFIRSTLOD

IMAGEMIPTAILSIZE

IMAGEMIPTAILOFFSET

IMAGEMIPTAILSTRIDE

Constructor Detail

VkSparseImageMemoryRequirements

Method Detail

sizeof

formatProperties

imageMipTailFirstLod

imageMipTailSize

imageMipTailOffset

imageMipTailStride

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nformatProperties

nimageMipTailFirstLod

nimageMipTailSize

nimageMipTailOffset

nimageMipTailStride