VkSparseImageMemoryBindInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSparseImageMemoryBindInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying sparse image memory bind info.
Valid Usage
- The subresource.mipLevel member of each element of pBinds must be less than the mipLevels specified in VkImageCreateInfo when image was created
- The subresource.arrayLayer member of each element of pBinds must be less than the arrayLayers specified in VkImageCreateInfo when image was created
Valid Usage (Implicit)
- image must be a valid VkImage handle
- pBinds must be a valid pointer to an array of bindCount valid VkSparseImageMemoryBind structures
- bindCount must be greater than 0
See Also

VkBindSparseInfo, VkSparseImageMemoryBind

Member documentation
- image – the VkImage object to be bound
- bindCount – the number of VkSparseImageMemoryBind structures in pBinds array
- pBinds – a pointer to an array of VkSparseImageMemoryBind structures
Layout
```
 struct VkSparseImageMemoryBindInfo {
     VkImage image;
     uint32_t bindCount;
     VkSparseImageMemoryBind const * pBinds;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BINDCOUNT` The struct member offsets.
`static int`	`IMAGE` The struct member offsets.
`static int`	`PBINDS` 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
`VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)` Creates a `VkSparseImageMemoryBindInfo` 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
`int`	`bindCount()` Returns the value of the `bindCount` field.
`static VkSparseImageMemoryBindInfo`	`calloc()` Returns a new `VkSparseImageMemoryBindInfo` instance allocated with `memCalloc`.
`static VkSparseImageMemoryBindInfo.Buffer`	`calloc(int capacity)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated with `memCalloc`.
`static VkSparseImageMemoryBindInfo`	`callocStack()` Returns a new `VkSparseImageMemoryBindInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBindInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBindInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBindInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBindInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageMemoryBindInfo`	`create()` Returns a new `VkSparseImageMemoryBindInfo` instance allocated with `BufferUtils`.
`static VkSparseImageMemoryBindInfo.Buffer`	`create(int capacity)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated with `BufferUtils`.
`static VkSparseImageMemoryBindInfo`	`create(long address)` Returns a new `VkSparseImageMemoryBindInfo` instance for the specified memory address.
`static VkSparseImageMemoryBindInfo.Buffer`	`create(long address, int capacity)` Create a `VkSparseImageMemoryBindInfo.Buffer` instance at the specified memory.
`static VkSparseImageMemoryBindInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSparseImageMemoryBindInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`image()` Returns the value of the `image` field.
`VkSparseImageMemoryBindInfo`	`image(long value)` Sets the specified value to the `image` field.
`static VkSparseImageMemoryBindInfo`	`malloc()` Returns a new `VkSparseImageMemoryBindInfo` instance allocated with `memAlloc`.
`static VkSparseImageMemoryBindInfo.Buffer`	`malloc(int capacity)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated with `memAlloc`.
`static VkSparseImageMemoryBindInfo`	`mallocStack()` Returns a new `VkSparseImageMemoryBindInfo` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryBindInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageMemoryBindInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBindInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseImageMemoryBindInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageMemoryBindInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nbindCount(long struct)` Unsafe version of `bindCount()`.
`static void`	`nbindCount(long struct, int value)` Sets the specified value to the `bindCount` field of the specified `struct`.
`static long`	`nimage(long struct)` Unsafe version of `image()`.
`static void`	`nimage(long struct, long value)` Unsafe version of `image`.
`static VkSparseImageMemoryBind.Buffer`	`npBinds(long struct)` Unsafe version of `pBinds()`.
`static void`	`npBinds(long struct, VkSparseImageMemoryBind.Buffer value)` Unsafe version of `pBinds`.
`VkSparseImageMemoryBind.Buffer`	`pBinds()` Returns a `VkSparseImageMemoryBind.Buffer` view of the struct array pointed to by the `pBinds` field.
`VkSparseImageMemoryBindInfo`	`pBinds(VkSparseImageMemoryBind.Buffer value)` Sets the address of the specified `VkSparseImageMemoryBind.Buffer` to the `pBinds` field.
`VkSparseImageMemoryBindInfo`	`set(long image, VkSparseImageMemoryBind.Buffer pBinds)` Initializes this struct with the specified values.
`VkSparseImageMemoryBindInfo`	`set(VkSparseImageMemoryBindInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - IMAGE
```
public static final int IMAGE
```
    The struct member offsets.
  - BINDCOUNT
```
public static final int BINDCOUNT
```
    The struct member offsets.
  - PBINDS
```
public static final int PBINDS
```
    The struct member offsets.
- Constructor Detail
  - VkSparseImageMemoryBindInfo
```
public VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)
```
    Creates a VkSparseImageMemoryBindInfo 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
  - image
```
public long image()
```
    Returns the value of the image field.
  - bindCount
```
public int bindCount()
```
    Returns the value of the bindCount field.
  - pBinds
```
public VkSparseImageMemoryBind.Buffer pBinds()
```
    Returns a VkSparseImageMemoryBind.Buffer view of the struct array pointed to by the pBinds field.
  - image
```
public VkSparseImageMemoryBindInfo image(long value)
```
    Sets the specified value to the image field.
  - pBinds
```
public VkSparseImageMemoryBindInfo pBinds(VkSparseImageMemoryBind.Buffer value)
```
    Sets the address of the specified VkSparseImageMemoryBind.Buffer to the pBinds field.
  - set
```
public VkSparseImageMemoryBindInfo set(long image,
                                       VkSparseImageMemoryBind.Buffer pBinds)
```
    Initializes this struct with the specified values.
  - set
```
public VkSparseImageMemoryBindInfo set(VkSparseImageMemoryBindInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSparseImageMemoryBindInfo malloc()
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSparseImageMemoryBindInfo calloc()
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSparseImageMemoryBindInfo create()
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated with BufferUtils.
  - create
```
public static VkSparseImageMemoryBindInfo create(long address)
```
    Returns a new VkSparseImageMemoryBindInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSparseImageMemoryBindInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageMemoryBindInfo.Buffer create(int capacity)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageMemoryBindInfo.Buffer create(long address,
                                                        int capacity)
```
    Create a VkSparseImageMemoryBindInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSparseImageMemoryBindInfo.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSparseImageMemoryBindInfo mallocStack()
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSparseImageMemoryBindInfo callocStack()
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSparseImageMemoryBindInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSparseImageMemoryBindInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageMemoryBindInfo.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
  - nimage
```
public static long nimage(long struct)
```
    Unsafe version of image().
  - nbindCount
```
public static int nbindCount(long struct)
```
    Unsafe version of bindCount().
  - npBinds
```
public static VkSparseImageMemoryBind.Buffer npBinds(long struct)
```
    Unsafe version of pBinds().
  - nimage
```
public static void nimage(long struct,
                          long value)
```
    Unsafe version of image.
  - nbindCount
```
public static void nbindCount(long struct,
                              int value)
```
    Sets the specified value to the bindCount field of the specified struct.
  - npBinds
```
public static void npBinds(long struct,
                           VkSparseImageMemoryBind.Buffer value)
```
    Unsafe version of pBinds.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkSparseImageMemoryBindInfo

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

IMAGE

BINDCOUNT

PBINDS

Constructor Detail

VkSparseImageMemoryBindInfo

Method Detail

sizeof

image

bindCount

pBinds

image

pBinds

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nimage

nbindCount

npBinds

nimage

nbindCount

npBinds

validate

validate