VkBindImageMemorySwapchainInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkBindImageMemorySwapchainInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying swapchain image memory to bind to.
Description

If swapchain is not NULL, the swapchain and imageIndex are used to determine the memory that the image is bound to, instead of memory and memoryOffset.

Memory can be bound to a swapchain and use the pDeviceIndices or pSplitInstanceBindRegions members of VkBindImageMemoryDeviceGroupInfo.

Valid Usage
- imageIndex must be less than the number of images in swapchain
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
- swapchain must be a valid VkSwapchainKHR handle
Host Synchronization
- Host access to swapchain must be externally synchronized
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- swapchain – NULL_HANDLE or a swapchain handle.
- imageIndex – an image index within swapchain.
Layout
```
 struct VkBindImageMemorySwapchainInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkSwapchainKHR swapchain;
     uint32_t imageIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`IMAGEINDEX` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`SWAPCHAIN` 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
`VkBindImageMemorySwapchainInfoKHR(java.nio.ByteBuffer container)` Creates a `VkBindImageMemorySwapchainInfoKHR` 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 VkBindImageMemorySwapchainInfoKHR`	`calloc()` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated with `memCalloc`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkBindImageMemorySwapchainInfoKHR`	`callocStack()` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemorySwapchainInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindImageMemorySwapchainInfoKHR`	`create()` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated with `BufferUtils`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkBindImageMemorySwapchainInfoKHR`	`create(long address)` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance for the specified memory address.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkBindImageMemorySwapchainInfoKHR.Buffer` instance at the specified memory.
`static VkBindImageMemorySwapchainInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`imageIndex()` Returns the value of the `imageIndex` field.
`VkBindImageMemorySwapchainInfoKHR`	`imageIndex(int value)` Sets the specified value to the `imageIndex` field.
`static VkBindImageMemorySwapchainInfoKHR`	`malloc()` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated with `memAlloc`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkBindImageMemorySwapchainInfoKHR`	`mallocStack()` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBindImageMemorySwapchainInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindImageMemorySwapchainInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBindImageMemorySwapchainInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindImageMemorySwapchainInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`nimageIndex(long struct)` Unsafe version of `imageIndex()`.
`static void`	`nimageIndex(long struct, int value)` Unsafe version of `imageIndex`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static long`	`nswapchain(long struct)` Unsafe version of `swapchain()`.
`static void`	`nswapchain(long struct, long value)` Unsafe version of `swapchain`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkBindImageMemorySwapchainInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkBindImageMemorySwapchainInfoKHR`	`set(int sType, long pNext, long swapchain, int imageIndex)` Initializes this struct with the specified values.
`VkBindImageMemorySwapchainInfoKHR`	`set(VkBindImageMemorySwapchainInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkBindImageMemorySwapchainInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`long`	`swapchain()` Returns the value of the `swapchain` field.
`VkBindImageMemorySwapchainInfoKHR`	`swapchain(long value)` Sets the specified value to the `swapchain` 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.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - SWAPCHAIN
```
public static final int SWAPCHAIN
```
    The struct member offsets.
  - IMAGEINDEX
```
public static final int IMAGEINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkBindImageMemorySwapchainInfoKHR
```
public VkBindImageMemorySwapchainInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkBindImageMemorySwapchainInfoKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - swapchain
```
public long swapchain()
```
    Returns the value of the swapchain field.
  - imageIndex
```
public int imageIndex()
```
    Returns the value of the imageIndex field.
  - sType
```
public VkBindImageMemorySwapchainInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBindImageMemorySwapchainInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - swapchain
```
public VkBindImageMemorySwapchainInfoKHR swapchain(long value)
```
    Sets the specified value to the swapchain field.
  - imageIndex
```
public VkBindImageMemorySwapchainInfoKHR imageIndex(int value)
```
    Sets the specified value to the imageIndex field.
  - set
```
public VkBindImageMemorySwapchainInfoKHR set(int sType,
                                             long pNext,
                                             long swapchain,
                                             int imageIndex)
```
    Initializes this struct with the specified values.
  - set
```
public VkBindImageMemorySwapchainInfoKHR set(VkBindImageMemorySwapchainInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBindImageMemorySwapchainInfoKHR malloc()
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBindImageMemorySwapchainInfoKHR calloc()
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBindImageMemorySwapchainInfoKHR create()
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkBindImageMemorySwapchainInfoKHR create(long address)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBindImageMemorySwapchainInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer create(int capacity)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer create(long address,
                                                              int capacity)
```
    Create a VkBindImageMemorySwapchainInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBindImageMemorySwapchainInfoKHR.Buffer createSafe(long address,
                                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBindImageMemorySwapchainInfoKHR mallocStack()
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBindImageMemorySwapchainInfoKHR callocStack()
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBindImageMemorySwapchainInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBindImageMemorySwapchainInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer mallocStack(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindImageMemorySwapchainInfoKHR.Buffer callocStack(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindImageMemorySwapchainInfoKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nswapchain
```
public static long nswapchain(long struct)
```
    Unsafe version of swapchain().
  - nimageIndex
```
public static int nimageIndex(long struct)
```
    Unsafe version of imageIndex().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nswapchain
```
public static void nswapchain(long struct,
                              long value)
```
    Unsafe version of swapchain.
  - nimageIndex
```
public static void nimageIndex(long struct,
                               int value)
```
    Unsafe version of imageIndex.

Class VkBindImageMemorySwapchainInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

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

STYPE

PNEXT

SWAPCHAIN

IMAGEINDEX

Constructor Detail

VkBindImageMemorySwapchainInfoKHR

Method Detail

sizeof

sType

pNext

swapchain

imageIndex

sType

pNext

swapchain

imageIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nswapchain

nimageIndex

nsType

npNext

nswapchain

nimageIndex