VkSparseMemoryBind (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSparseMemoryBind
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a sparse memory bind operation.
Description

The binding range [resourceOffset, resourceOffset + size) has different constraints based on flags. If flags contains SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the mip tail region of the metadata aspect. This metadata region is defined by:

metadataRegion = [base, base imageMipTailSize)

base = imageMipTailOffset imageMipTailStride × n

and imageMipTailOffset, imageMipTailSize, and imageMipTailStride values are from the VkSparseImageMemoryRequirements corresponding to the metadata aspect of the image, and n is a valid array layer index for the image,

imageMipTailStride is considered to be zero for aspects where VkSparseImageMemoryRequirements::formatProperties.flags contains SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT.

If flags does not contain SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the range [0,VkMemoryRequirements::size).

Valid Usage
- If memory is not NULL_HANDLE, memory and memoryOffset must match the memory requirements of the resource, as described in section Resource Memory Association
- If memory is not NULL_HANDLE, memory must not have been created with a memory type that reports MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit set
- size must be greater than 0
- resourceOffset must be less than the size of the resource
- size must be less than or equal to the size of the resource minus resourceOffset
- memoryOffset must be less than the size of memory
- size must be less than or equal to the size of memory minus memoryOffset
- If memory was created with VkExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in VkExternalMemoryBufferCreateInfo::handleTypes or VkExternalMemoryImageCreateInfo::handleTypes when the resource 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 VkExternalMemoryBufferCreateInfo::handleTypes or VkExternalMemoryImageCreateInfo::handleTypes when the resource was created.
Valid Usage (Implicit)
- If memory is not NULL_HANDLE, memory must be a valid VkDeviceMemory handle
- flags must be a valid combination of VkSparseMemoryBindFlagBits values
See Also

VkSparseBufferMemoryBindInfo, VkSparseImageOpaqueMemoryBindInfo

Member documentation
- resourceOffset – the offset into the resource.
- size – the size of the memory region to be bound.
- memory – the VkDeviceMemory object that the range of the resource is bound to. If memory is NULL_HANDLE, the range is unbound.
- memoryOffset – the offset into the VkDeviceMemory object to bind the resource range to. If memory is NULL_HANDLE, this value is ignored.
- flags – a bitmask of VkSparseMemoryBindFlagBits specifying usage of the binding operation.
Layout
```
 struct VkSparseMemoryBind {
     VkDeviceSize resourceOffset;
     VkDeviceSize size;
     VkDeviceMemory memory;
     VkDeviceSize memoryOffset;
     VkSparseMemoryBindFlags flags;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`MEMORY` The struct member offsets.
`static int`	`MEMORYOFFSET` The struct member offsets.
`static int`	`RESOURCEOFFSET` The struct member offsets.
`static int`	`SIZE` 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
`VkSparseMemoryBind(java.nio.ByteBuffer container)` Creates a `VkSparseMemoryBind` 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 VkSparseMemoryBind`	`calloc()` Returns a new `VkSparseMemoryBind` instance allocated with `memCalloc`.
`static VkSparseMemoryBind.Buffer`	`calloc(int capacity)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memCalloc`.
`static VkSparseMemoryBind`	`callocStack()` Returns a new `VkSparseMemoryBind` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseMemoryBind.Buffer`	`callocStack(int capacity)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseMemoryBind.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseMemoryBind`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseMemoryBind`	`create()` Returns a new `VkSparseMemoryBind` instance allocated with `BufferUtils`.
`static VkSparseMemoryBind.Buffer`	`create(int capacity)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `BufferUtils`.
`static VkSparseMemoryBind`	`create(long address)` Returns a new `VkSparseMemoryBind` instance for the specified memory address.
`static VkSparseMemoryBind.Buffer`	`create(long address, int capacity)` Create a `VkSparseMemoryBind.Buffer` instance at the specified memory.
`static VkSparseMemoryBind`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSparseMemoryBind.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkSparseMemoryBind`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkSparseMemoryBind`	`malloc()` Returns a new `VkSparseMemoryBind` instance allocated with `memAlloc`.
`static VkSparseMemoryBind.Buffer`	`malloc(int capacity)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memAlloc`.
`static VkSparseMemoryBind`	`mallocStack()` Returns a new `VkSparseMemoryBind` instance allocated on the thread-local `MemoryStack`.
`static VkSparseMemoryBind.Buffer`	`mallocStack(int capacity)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSparseMemoryBind.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseMemoryBind`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack`.
`long`	`memory()` Returns the value of the `memory` field.
`VkSparseMemoryBind`	`memory(long value)` Sets the specified value to the `memory` field.
`long`	`memoryOffset()` Returns the value of the `memoryOffset` field.
`VkSparseMemoryBind`	`memoryOffset(long value)` Sets the specified value to the `memoryOffset` field.
`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 long`	`nresourceOffset(long struct)` Unsafe version of `resourceOffset()`.
`static void`	`nresourceOffset(long struct, long value)` Unsafe version of `resourceOffset`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)` Unsafe version of `size`.
`long`	`resourceOffset()` Returns the value of the `resourceOffset` field.
`VkSparseMemoryBind`	`resourceOffset(long value)` Sets the specified value to the `resourceOffset` field.
`VkSparseMemoryBind`	`set(long resourceOffset, long size, long memory, long memoryOffset, int flags)` Initializes this struct with the specified values.
`VkSparseMemoryBind`	`set(VkSparseMemoryBind src)` Copies the specified struct data to this struct.
`long`	`size()` Returns the value of the `size` field.
`VkSparseMemoryBind`	`size(long value)` Sets the specified value to the `size` field.
`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.
  - RESOURCEOFFSET
```
public static final int RESOURCEOFFSET
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    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
  - VkSparseMemoryBind
```
public VkSparseMemoryBind(java.nio.ByteBuffer container)
```
    Creates a VkSparseMemoryBind 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
  - resourceOffset
```
public long resourceOffset()
```
    Returns the value of the resourceOffset field.
  - size
```
public long size()
```
    Returns the value of the size 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.
  - resourceOffset
```
public VkSparseMemoryBind resourceOffset(long value)
```
    Sets the specified value to the resourceOffset field.
  - size
```
public VkSparseMemoryBind size(long value)
```
    Sets the specified value to the size field.
  - memory
```
public VkSparseMemoryBind memory(long value)
```
    Sets the specified value to the memory field.
  - memoryOffset
```
public VkSparseMemoryBind memoryOffset(long value)
```
    Sets the specified value to the memoryOffset field.
  - flags
```
public VkSparseMemoryBind flags(int value)
```
    Sets the specified value to the flags field.
  - set
```
public VkSparseMemoryBind set(long resourceOffset,
                              long size,
                              long memory,
                              long memoryOffset,
                              int flags)
```
    Initializes this struct with the specified values.
  - set
```
public VkSparseMemoryBind set(VkSparseMemoryBind src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSparseMemoryBind malloc()
```
    Returns a new VkSparseMemoryBind instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSparseMemoryBind calloc()
```
    Returns a new VkSparseMemoryBind instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSparseMemoryBind create()
```
    Returns a new VkSparseMemoryBind instance allocated with BufferUtils.
  - create
```
public static VkSparseMemoryBind create(long address)
```
    Returns a new VkSparseMemoryBind instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSparseMemoryBind createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSparseMemoryBind.Buffer malloc(int capacity)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSparseMemoryBind.Buffer calloc(int capacity)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseMemoryBind.Buffer create(int capacity)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseMemoryBind.Buffer create(long address,
                                               int capacity)
```
    Create a VkSparseMemoryBind.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSparseMemoryBind.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSparseMemoryBind mallocStack()
```
    Returns a new VkSparseMemoryBind instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSparseMemoryBind callocStack()
```
    Returns a new VkSparseMemoryBind instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSparseMemoryBind mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseMemoryBind instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSparseMemoryBind callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseMemoryBind instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSparseMemoryBind.Buffer mallocStack(int capacity)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseMemoryBind.Buffer callocStack(int capacity)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSparseMemoryBind.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseMemoryBind.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseMemoryBind.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseMemoryBind.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
  - nresourceOffset
```
public static long nresourceOffset(long struct)
```
    Unsafe version of resourceOffset().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - 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().
  - nresourceOffset
```
public static void nresourceOffset(long struct,
                                   long value)
```
    Unsafe version of resourceOffset.
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Unsafe version of size.
  - 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 VkSparseMemoryBind

Description

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

RESOURCEOFFSET

SIZE

MEMORY

MEMORYOFFSET

FLAGS

Constructor Detail

VkSparseMemoryBind

Method Detail

sizeof

resourceOffset

size

memory

memoryOffset

flags

resourceOffset

size

memory

memoryOffset

flags

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nresourceOffset

nsize

nmemory

nmemoryOffset

nflags

nresourceOffset

nsize

nmemory

nmemoryOffset

nflags