VkSparseImageMemoryBind (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSparseImageMemoryBind
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying sparse image memory bind.
Valid Usage
- If the sparse aliased residency feature is not enabled, and if any other resources are bound to ranges of memory, the range of memory being bound must not overlap with those bound ranges
- memory and memoryOffset must match the memory requirements of the calling command’s image, as described in section Resource Memory Association
- subresource must be a valid image subresource for image (see Image Views)
- offset.x must be a multiple of the sparse image block width (VkSparseImageFormatProperties::imageGranularity.width) of the image
- extent.width must either be a multiple of the sparse image block width of the image, or else (extent.width offset.x) must equal the width of the image subresource
- offset.y must be a multiple of the sparse image block height (VkSparseImageFormatProperties::imageGranularity.height) of the image
- extent.height must either be a multiple of the sparse image block height of the image, or else (extent.height offset.y) must equal the height of the image subresource
- offset.z must be a multiple of the sparse image block depth (VkSparseImageFormatProperties::imageGranularity.depth) of the image
- extent.depth must either be a multiple of the sparse image block depth of the image, or else (extent.depth offset.z) must equal the depth of the image subresource
- If memory was created with VkExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in VkExternalMemoryImageCreateInfo::handleTypes when the image was created.
- If memory was created by a memory import operation, the external handle type of the imported memory must also have been set in VkExternalMemoryImageCreateInfo::handleTypes when image was created.
Valid Usage (Implicit)
- subresource must be a valid VkImageSubresource structure
- If memory is not NULL_HANDLE, memory must be a valid VkDeviceMemory handle
- flags must be a valid combination of VkSparseMemoryBindFlagBits values
See Also

VkExtent3D, VkImageSubresource, VkOffset3D, VkSparseImageMemoryBindInfo

Member documentation
- subresource – the image aspect and region of interest in the image.
- offset – are the coordinates of the first texel within the image subresource to bind.
- extent – the size in texels of the region within the image subresource to bind. The extent must be a multiple of the sparse image block dimensions, except when binding sparse image blocks along the edge of an image subresource it can instead be such that any coordinate of offset + extent equals the corresponding dimensions of the image subresource.
- memory – the VkDeviceMemory object that the sparse image blocks of the image are bound to. If memory is NULL_HANDLE, the sparse image blocks are unbound.
- memoryOffset – an offset into VkDeviceMemory object. If memory is NULL_HANDLE, this value is ignored.
- flags – are sparse memory binding flags.
Layout
```
 struct VkSparseImageMemoryBind {
     VkImageSubresource subresource;
     VkOffset3D offset;
     VkExtent3D extent;
     VkDeviceMemory memory;
     VkDeviceSize memoryOffset;
     VkSparseMemoryBindFlags flags;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkSparseImageMemoryBind.Buffer
An array of VkSparseImageMemoryBind 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`	`VkSparseImageMemoryBind.Buffer` An array of `VkSparseImageMemoryBind` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`EXTENT` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`MEMORY` The struct member offsets.
`static int`	`MEMORYOFFSET` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SUBRESOURCE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkSparseImageMemoryBind(java.nio.ByteBuffer container)` Creates a `VkSparseImageMemoryBind` 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 VkSparseImageMemoryBind`	`calloc()` Returns a new `VkSparseImageMemoryBind` instance allocated with `memCalloc`.
`static VkSparseImageMemoryBind.Buffer`	`calloc(int capacity)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `memCalloc`.
`static VkSparseImageMemoryBind`	`callocStack()` Returns a new `VkSparseImageMemoryBind` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBind.Buffer`	`callocStack(int capacity)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBind.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBind`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBind`	`create()` Returns a new `VkSparseImageMemoryBind` instance allocated with `BufferUtils`.
`static VkSparseImageMemoryBind.Buffer`	`create(int capacity)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `BufferUtils`.
`static VkSparseImageMemoryBind`	`create(long address)` Returns a new `VkSparseImageMemoryBind` instance for the specified memory address.
`static VkSparseImageMemoryBind.Buffer`	`create(long address, int capacity)` Create a `VkSparseImageMemoryBind.Buffer` instance at the specified memory.
`static VkSparseImageMemoryBind`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSparseImageMemoryBind.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkExtent3D`	`extent()` Returns a `VkExtent3D` view of the `extent` field.
`VkSparseImageMemoryBind`	`extent(java.util.function.Consumer<VkExtent3D> consumer)` Passes the `extent` field to the specified `Consumer`.
`VkSparseImageMemoryBind`	`extent(VkExtent3D value)` Copies the specified `VkExtent3D` to the `extent` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkSparseImageMemoryBind`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkSparseImageMemoryBind`	`malloc()` Returns a new `VkSparseImageMemoryBind` instance allocated with `memAlloc`.
`static VkSparseImageMemoryBind.Buffer`	`malloc(int capacity)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `memAlloc`.
`static VkSparseImageMemoryBind`	`mallocStack()` Returns a new `VkSparseImageMemoryBind` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryBind.Buffer`	`mallocStack(int capacity)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryBind.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseImageMemoryBind`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack`.
`long`	`memory()` Returns the value of the `memory` field.
`VkSparseImageMemoryBind`	`memory(long value)` Sets the specified value to the `memory` field.
`long`	`memoryOffset()` Returns the value of the `memoryOffset` field.
`VkSparseImageMemoryBind`	`memoryOffset(long value)` Sets the specified value to the `memoryOffset` field.
`static VkExtent3D`	`nextent(long struct)` Unsafe version of `extent()`.
`static void`	`nextent(long struct, VkExtent3D value)` Unsafe version of `extent`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`nmemory(long struct)` Unsafe version of `memory()`.
`static void`	`nmemory(long struct, long value)` Unsafe version of `memory`.
`static long`	`nmemoryOffset(long struct)` Unsafe version of `memoryOffset()`.
`static void`	`nmemoryOffset(long struct, long value)` Unsafe version of `memoryOffset`.
`static VkOffset3D`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, VkOffset3D value)` Unsafe version of `offset`.
`static VkImageSubresource`	`nsubresource(long struct)` Unsafe version of `subresource()`.
`static void`	`nsubresource(long struct, VkImageSubresource value)` Unsafe version of `subresource`.
`VkOffset3D`	`offset()` Returns a `VkOffset3D` view of the `offset` field.
`VkSparseImageMemoryBind`	`offset(java.util.function.Consumer<VkOffset3D> consumer)` Passes the `offset` field to the specified `Consumer`.
`VkSparseImageMemoryBind`	`offset(VkOffset3D value)` Copies the specified `VkOffset3D` to the `offset` field.
`VkSparseImageMemoryBind`	`set(VkImageSubresource subresource, VkOffset3D offset, VkExtent3D extent, long memory, long memoryOffset, int flags)` Initializes this struct with the specified values.
`VkSparseImageMemoryBind`	`set(VkSparseImageMemoryBind src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`VkImageSubresource`	`subresource()` Returns a `VkImageSubresource` view of the `subresource` field.
`VkSparseImageMemoryBind`	`subresource(java.util.function.Consumer<VkImageSubresource> consumer)` Passes the `subresource` field to the specified `Consumer`.
`VkSparseImageMemoryBind`	`subresource(VkImageSubresource value)` Copies the specified `VkImageSubresource` to the `subresource` field.

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.
  - SUBRESOURCE
```
public static final int SUBRESOURCE
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - EXTENT
```
public static final int EXTENT
```
    The struct member offsets.
  - MEMORY
```
public static final int MEMORY
```
    The struct member offsets.
  - MEMORYOFFSET
```
public static final int MEMORYOFFSET
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
- Constructor Detail
  - VkSparseImageMemoryBind
```
public VkSparseImageMemoryBind(java.nio.ByteBuffer container)
```
    Creates a VkSparseImageMemoryBind 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
  - subresource
```
public VkImageSubresource subresource()
```
    Returns a VkImageSubresource view of the subresource field.
  - offset
```
public VkOffset3D offset()
```
    Returns a VkOffset3D view of the offset field.
  - extent
```
public VkExtent3D extent()
```
    Returns a VkExtent3D view of the extent field.
  - memory
```
public long memory()
```
    Returns the value of the memory field.
  - memoryOffset
```
public long memoryOffset()
```
    Returns the value of the memoryOffset field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - subresource
```
public VkSparseImageMemoryBind subresource(VkImageSubresource value)
```
    Copies the specified VkImageSubresource to the subresource field.
  - subresource
```
public VkSparseImageMemoryBind subresource(java.util.function.Consumer<VkImageSubresource> consumer)
```
    Passes the subresource field to the specified Consumer.
  - offset
```
public VkSparseImageMemoryBind offset(VkOffset3D value)
```
    Copies the specified VkOffset3D to the offset field.
  - offset
```
public VkSparseImageMemoryBind offset(java.util.function.Consumer<VkOffset3D> consumer)
```
    Passes the offset field to the specified Consumer.
  - extent
```
public VkSparseImageMemoryBind extent(VkExtent3D value)
```
    Copies the specified VkExtent3D to the extent field.
  - extent
```
public VkSparseImageMemoryBind extent(java.util.function.Consumer<VkExtent3D> consumer)
```
    Passes the extent field to the specified Consumer.
  - memory
```
public VkSparseImageMemoryBind memory(long value)
```
    Sets the specified value to the memory field.
  - memoryOffset
```
public VkSparseImageMemoryBind memoryOffset(long value)
```
    Sets the specified value to the memoryOffset field.
  - flags
```
public VkSparseImageMemoryBind flags(int value)
```
    Sets the specified value to the flags field.
  - set
```
public VkSparseImageMemoryBind set(VkImageSubresource subresource,
                                   VkOffset3D offset,
                                   VkExtent3D extent,
                                   long memory,
                                   long memoryOffset,
                                   int flags)
```
    Initializes this struct with the specified values.
  - set
```
public VkSparseImageMemoryBind set(VkSparseImageMemoryBind src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSparseImageMemoryBind malloc()
```
    Returns a new VkSparseImageMemoryBind instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSparseImageMemoryBind calloc()
```
    Returns a new VkSparseImageMemoryBind instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSparseImageMemoryBind create()
```
    Returns a new VkSparseImageMemoryBind instance allocated with BufferUtils.
  - create
```
public static VkSparseImageMemoryBind create(long address)
```
    Returns a new VkSparseImageMemoryBind instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSparseImageMemoryBind createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSparseImageMemoryBind.Buffer malloc(int capacity)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSparseImageMemoryBind.Buffer calloc(int capacity)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageMemoryBind.Buffer create(int capacity)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageMemoryBind.Buffer create(long address,
                                                    int capacity)
```
    Create a VkSparseImageMemoryBind.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSparseImageMemoryBind.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSparseImageMemoryBind mallocStack()
```
    Returns a new VkSparseImageMemoryBind instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSparseImageMemoryBind callocStack()
```
    Returns a new VkSparseImageMemoryBind instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSparseImageMemoryBind mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBind instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSparseImageMemoryBind callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBind instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSparseImageMemoryBind.Buffer mallocStack(int capacity)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryBind.Buffer callocStack(int capacity)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSparseImageMemoryBind.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBind.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryBind.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBind.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
  - nsubresource
```
public static VkImageSubresource nsubresource(long struct)
```
    Unsafe version of subresource().
  - noffset
```
public static VkOffset3D noffset(long struct)
```
    Unsafe version of offset().
  - nextent
```
public static VkExtent3D nextent(long struct)
```
    Unsafe version of extent().
  - nmemory
```
public static long nmemory(long struct)
```
    Unsafe version of memory().
  - nmemoryOffset
```
public static long nmemoryOffset(long struct)
```
    Unsafe version of memoryOffset().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nsubresource
```
public static void nsubresource(long struct,
                                VkImageSubresource value)
```
    Unsafe version of subresource.
  - noffset
```
public static void noffset(long struct,
                           VkOffset3D value)
```
    Unsafe version of offset.
  - nextent
```
public static void nextent(long struct,
                           VkExtent3D value)
```
    Unsafe version of extent.
  - nmemory
```
public static void nmemory(long struct,
                           long value)
```
    Unsafe version of memory.
  - nmemoryOffset
```
public static void nmemoryOffset(long struct,
                                 long value)
```
    Unsafe version of memoryOffset.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.

Class VkSparseImageMemoryBind

Valid Usage

Valid Usage (Implicit)

See Also

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

SUBRESOURCE

OFFSET

EXTENT

MEMORY

MEMORYOFFSET

FLAGS

Constructor Detail

VkSparseImageMemoryBind

Method Detail

sizeof

subresource

offset

extent

memory

memoryOffset

flags

subresource

subresource

offset

offset

extent

extent

memory

memoryOffset

flags

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsubresource

noffset

nextent

nmemory

nmemoryOffset

nflags

nsubresource

noffset

nextent

nmemory

nmemoryOffset

nflags