VkImageSwapchainCreateInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageSwapchainCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Specify that an image will be bound to swapchain memory.
Valid Usage
- If swapchain is not NULL_HANDLE, the fields of VkImageCreateInfo must match the implied image creation parameters of the swapchain
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
- If swapchain is not NULL_HANDLE, swapchain must be a valid VkSwapchainKHR handle
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- swapchain – NULL_HANDLE or a handle of a swapchain that the image will be bound to.
Layout
```
 struct VkImageSwapchainCreateInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkSwapchainKHR swapchain;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkImageSwapchainCreateInfoKHR

Valid Usage

Valid Usage (Implicit)

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

Constructor Detail

VkImageSwapchainCreateInfoKHR

Method Detail

sizeof

sType

pNext

swapchain

sType

pNext

swapchain

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nswapchain

nsType

npNext

nswapchain