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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSwapchainCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created swapchain object.
Valid Usage
- surface must be a surface that is supported by the device as determined using GetPhysicalDeviceSurfaceSupportKHR
- minImageCount must be less than or equal to the value returned in the maxImageCount member of the VkSurfaceCapabilitiesKHR structure returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface if the returned maxImageCount is not zero
- If presentMode is not PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR nor PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, then minImageCount must be greater than or equal to the value returned in the minImageCount member of the VkSurfaceCapabilitiesKHR structure returned by GetPhysicalDeviceSurfaceCapabilitiesKHR for the surface
- minImageCount must be 1 if presentMode is either PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR
- imageFormat and imageColorSpace must match the format and colorSpace members, respectively, of one of the VkSurfaceFormatKHR structures returned by vkGetPhysicalDeviceSurfaceFormatsKHR for the surface
- imageExtent must be between minImageExtent and maxImageExtent, inclusive, where minImageExtent and maxImageExtent are members of the VkSurfaceCapabilitiesKHR structure returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface
- imageExtent members width and height must both be non-zero
- imageArrayLayers must be greater than 0 and less than or equal to the maxImageArrayLayers member of the VkSurfaceCapabilitiesKHR structure returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface
- If presentMode is PRESENT_MODE_IMMEDIATE_KHR, PRESENT_MODE_MAILBOX_KHR, PRESENT_MODE_FIFO_KHR or PRESENT_MODE_FIFO_RELAXED_KHR, imageUsage must be a subset of the supported usage flags present in the supportedUsageFlags member of the VkSurfaceCapabilitiesKHR structure returned by GetPhysicalDeviceSurfaceCapabilitiesKHR for surface
- If presentMode is PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, imageUsage must be a subset of the supported usage flags present in the sharedPresentSupportedUsageFlags member of the VkSharedPresentSurfaceCapabilitiesKHR structure returned by GetPhysicalDeviceSurfaceCapabilities2KHR for surface
- If imageSharingMode is SHARING_MODE_CONCURRENT, pQueueFamilyIndices must be a valid pointer to an array of queueFamilyIndexCount uint32_t values
- If imageSharingMode is SHARING_MODE_CONCURRENT, queueFamilyIndexCount must be greater than 1
- If imageSharingMode is SHARING_MODE_CONCURRENT, each element of pQueueFamilyIndices must be unique and must be less than pQueueFamilyPropertyCount returned by either GetPhysicalDeviceQueueFamilyProperties or GetPhysicalDeviceQueueFamilyProperties2 for the physicalDevice that was used to create device
- preTransform must be one of the bits present in the supportedTransforms member of the VkSurfaceCapabilitiesKHR structure returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface
- compositeAlpha must be one of the bits present in the supportedCompositeAlpha member of the VkSurfaceCapabilitiesKHR structure returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface
- presentMode must be one of the VkPresentModeKHR values returned by vkGetPhysicalDeviceSurfacePresentModesKHR for the surface
- If the logical device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount equal to 1, flags must not contain SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
- If oldSwapchain is not NULL_HANDLE, oldSwapchain must be a non-retired swapchain associated with native window referred to by surface
- The implied image creation parameters of the swapchain must be supported as reported by GetPhysicalDeviceImageFormatProperties
- If flags contains SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR then the pNext chain must include a VkImageFormatListCreateInfo structure with a viewFormatCount greater than zero and pViewFormats must have an element equal to imageFormat
- If a VkImageFormatListCreateInfo structure was included in the pNext chain and VkImageFormatListCreateInfo::viewFormatCount is not zero then all of the formats in VkImageFormatListCreateInfo::pViewFormats must be compatible with the format as described in the compatibility table
- If flags does not contain SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR and the pNext chain include a VkImageFormatListCreateInfo structure then VkImageFormatListCreateInfo::viewFormatCount must be 0 or 1
- If flags contains SWAPCHAIN_CREATE_PROTECTED_BIT_KHR, then VkSurfaceProtectedCapabilitiesKHR::supportsProtected must be TRUE in the VkSurfaceProtectedCapabilitiesKHR structure returned by GetPhysicalDeviceSurfaceCapabilities2KHR for surface
- If the pNext chain includes a VkSurfaceFullScreenExclusiveInfoEXT structure with its fullScreenExclusive member set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and surface was created using CreateWin32SurfaceKHR, a VkSurfaceFullScreenExclusiveWin32InfoEXT structure must be included in the pNext chain
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkDeviceGroupSwapchainCreateInfoKHR, VkImageFormatListCreateInfo, VkSurfaceFullScreenExclusiveInfoEXT, VkSurfaceFullScreenExclusiveWin32InfoEXT, VkSwapchainCounterCreateInfoEXT, or VkSwapchainDisplayNativeHdrCreateInfoAMD
- The sType value of each struct in the pNext chain must be unique
- flags must be a valid combination of VkSwapchainCreateFlagBitsKHR values
- surface must be a valid VkSurfaceKHR handle
- imageFormat must be a valid VkFormat value
- imageColorSpace must be a valid VkColorSpaceKHR value
- imageUsage must be a valid combination of VkImageUsageFlagBits values
- imageUsage must not be 0
- imageSharingMode must be a valid VkSharingMode value
- preTransform must be a valid VkSurfaceTransformFlagBitsKHR value
- compositeAlpha must be a valid VkCompositeAlphaFlagBitsKHR value
- presentMode must be a valid VkPresentModeKHR value
- If oldSwapchain is not NULL_HANDLE, oldSwapchain must be a valid VkSwapchainKHR handle
- If oldSwapchain is a valid handle, it must have been created, allocated, or retrieved from surface
- Both of oldSwapchain, and surface that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkInstance
See Also

VkExtent2D, CreateSharedSwapchainsKHR, CreateSwapchainKHR

Layout
```
 struct VkSwapchainCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkSwapchainCreateFlagsKHR flags();
     VkSurfaceKHR surface();
     uint32_t minImageCount();
     VkFormat imageFormat();
     VkColorSpaceKHR imageColorSpace();
     VkExtent2D imageExtent();
     uint32_t imageArrayLayers();
     VkImageUsageFlags imageUsage();
     VkSharingMode imageSharingMode();
     uint32_t queueFamilyIndexCount();
     uint32_t const * pQueueFamilyIndices();
     VkSurfaceTransformFlagBitsKHR preTransform();
     VkCompositeAlphaFlagBitsKHR compositeAlpha();
     VkPresentModeKHR presentMode();
     VkBool32 clipped();
     VkSwapchainKHR oldSwapchain();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkSwapchainCreateInfoKHR.Buffer
An array of VkSwapchainCreateInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`CLIPPED COMPOSITEALPHA FLAGS IMAGEARRAYLAYERS IMAGECOLORSPACE IMAGEEXTENT IMAGEFORMAT IMAGESHARINGMODE IMAGEUSAGE MINIMAGECOUNT OLDSWAPCHAIN PNEXT PQUEUEFAMILYINDICES PRESENTMODE PRETRANSFORM QUEUEFAMILYINDEXCOUNT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE SURFACE`	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	Description
`VkSwapchainCreateInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkSwapchainCreateInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkSwapchainCreateInfoKHR`	`calloc()`	Returns a new `VkSwapchainCreateInfoKHR` instance allocated with `memCalloc`.
`static VkSwapchainCreateInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkSwapchainCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkSwapchainCreateInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSwapchainCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSwapchainCreateInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSwapchainCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSwapchainCreateInfoKHR`	`callocStack()`	Deprecated.
`static VkSwapchainCreateInfoKHR.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkSwapchainCreateInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkSwapchainCreateInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`boolean`	`clipped()`	specifies whether the Vulkan implementation is allowed to discard rendering operations that affect regions of the surface that are not visible.
`VkSwapchainCreateInfoKHR`	`clipped(boolean value)`	Sets the specified value to the `clipped()` field.
`int`	`compositeAlpha()`	a `VkCompositeAlphaFlagBitsKHR` value indicating the alpha compositing mode to use when this surface is composited together with other surfaces on certain window systems.
`VkSwapchainCreateInfoKHR`	`compositeAlpha(int value)`	Sets the specified value to the `compositeAlpha()` field.
`static VkSwapchainCreateInfoKHR`	`create()`	Returns a new `VkSwapchainCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkSwapchainCreateInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkSwapchainCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkSwapchainCreateInfoKHR`	`create(long address)`	Returns a new `VkSwapchainCreateInfoKHR` instance for the specified memory address.
`static VkSwapchainCreateInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkSwapchainCreateInfoKHR.Buffer` instance at the specified memory.
`static VkSwapchainCreateInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkSwapchainCreateInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	a bitmask of `VkSwapchainCreateFlagBitsKHR` indicating parameters of the swapchain creation.
`VkSwapchainCreateInfoKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`int`	`imageArrayLayers()`	the number of views in a multiview/stereo surface.
`VkSwapchainCreateInfoKHR`	`imageArrayLayers(int value)`	Sets the specified value to the `imageArrayLayers()` field.
`int`	`imageColorSpace()`	a `VkColorSpaceKHR` value specifying the way the swapchain interprets image data.
`VkSwapchainCreateInfoKHR`	`imageColorSpace(int value)`	Sets the specified value to the `imageColorSpace()` field.
`VkExtent2D`	`imageExtent()`	the size (in pixels) of the swapchain image(s).
`VkSwapchainCreateInfoKHR`	`imageExtent(java.util.function.Consumer<VkExtent2D> consumer)`	Passes the `imageExtent()` field to the specified `Consumer`.
`VkSwapchainCreateInfoKHR`	`imageExtent(VkExtent2D value)`	Copies the specified `VkExtent2D` to the `imageExtent()` field.
`int`	`imageFormat()`	a `VkFormat` value specifying the format the swapchain image(s) will be created with.
`VkSwapchainCreateInfoKHR`	`imageFormat(int value)`	Sets the specified value to the `imageFormat()` field.
`int`	`imageSharingMode()`	the sharing mode used for the image(s) of the swapchain.
`VkSwapchainCreateInfoKHR`	`imageSharingMode(int value)`	Sets the specified value to the `imageSharingMode()` field.
`int`	`imageUsage()`	a bitmask of `VkImageUsageFlagBits` describing the intended usage of the (acquired) swapchain images.
`VkSwapchainCreateInfoKHR`	`imageUsage(int value)`	Sets the specified value to the `imageUsage()` field.
`static VkSwapchainCreateInfoKHR`	`malloc()`	Returns a new `VkSwapchainCreateInfoKHR` instance allocated with `memAlloc`.
`static VkSwapchainCreateInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkSwapchainCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkSwapchainCreateInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSwapchainCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSwapchainCreateInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSwapchainCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`static VkSwapchainCreateInfoKHR`	`mallocStack()`	Deprecated.
`static VkSwapchainCreateInfoKHR.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkSwapchainCreateInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkSwapchainCreateInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`int`	`minImageCount()`	the minimum number of presentable images that the application needs.
`VkSwapchainCreateInfoKHR`	`minImageCount(int value)`	Sets the specified value to the `minImageCount()` field.
`static int`	`nclipped(long struct)`	Unsafe version of `clipped()`.
`static void`	`nclipped(long struct, int value)`	Unsafe version of `clipped`.
`static int`	`ncompositeAlpha(long struct)`	Unsafe version of `compositeAlpha()`.
`static void`	`ncompositeAlpha(long struct, int value)`	Unsafe version of `compositeAlpha`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static int`	`nimageArrayLayers(long struct)`	Unsafe version of `imageArrayLayers()`.
`static void`	`nimageArrayLayers(long struct, int value)`	Unsafe version of `imageArrayLayers`.
`static int`	`nimageColorSpace(long struct)`	Unsafe version of `imageColorSpace()`.
`static void`	`nimageColorSpace(long struct, int value)`	Unsafe version of `imageColorSpace`.
`static VkExtent2D`	`nimageExtent(long struct)`	Unsafe version of `imageExtent()`.
`static void`	`nimageExtent(long struct, VkExtent2D value)`	Unsafe version of `imageExtent`.
`static int`	`nimageFormat(long struct)`	Unsafe version of `imageFormat()`.
`static void`	`nimageFormat(long struct, int value)`	Unsafe version of `imageFormat`.
`static int`	`nimageSharingMode(long struct)`	Unsafe version of `imageSharingMode()`.
`static void`	`nimageSharingMode(long struct, int value)`	Unsafe version of `imageSharingMode`.
`static int`	`nimageUsage(long struct)`	Unsafe version of `imageUsage()`.
`static void`	`nimageUsage(long struct, int value)`	Unsafe version of `imageUsage`.
`static int`	`nminImageCount(long struct)`	Unsafe version of `minImageCount()`.
`static void`	`nminImageCount(long struct, int value)`	Unsafe version of `minImageCount`.
`static long`	`noldSwapchain(long struct)`	Unsafe version of `oldSwapchain()`.
`static void`	`noldSwapchain(long struct, long value)`	Unsafe version of `oldSwapchain`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static java.nio.IntBuffer`	`npQueueFamilyIndices(long struct)`	Unsafe version of `pQueueFamilyIndices`.
`static void`	`npQueueFamilyIndices(long struct, java.nio.IntBuffer value)`	Unsafe version of `pQueueFamilyIndices`.
`static int`	`npresentMode(long struct)`	Unsafe version of `presentMode()`.
`static void`	`npresentMode(long struct, int value)`	Unsafe version of `presentMode`.
`static int`	`npreTransform(long struct)`	Unsafe version of `preTransform()`.
`static void`	`npreTransform(long struct, int value)`	Unsafe version of `preTransform`.
`static int`	`nqueueFamilyIndexCount(long struct)`	Unsafe version of `queueFamilyIndexCount()`.
`static void`	`nqueueFamilyIndexCount(long struct, int value)`	Sets the specified value to the `queueFamilyIndexCount` field of the specified `struct`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static long`	`nsurface(long struct)`	Unsafe version of `surface()`.
`static void`	`nsurface(long struct, long value)`	Unsafe version of `surface`.
`long`	`oldSwapchain()`	`NULL_HANDLE`, or the existing non-retired swapchain currently associated with `surface`.
`VkSwapchainCreateInfoKHR`	`oldSwapchain(long value)`	Sets the specified value to the `oldSwapchain()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkSwapchainCreateInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkSwapchainCreateInfoKHR`	`pNext(VkDeviceGroupSwapchainCreateInfoKHR value)`	Prepends the specified `VkDeviceGroupSwapchainCreateInfoKHR` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkImageFormatListCreateInfo value)`	Prepends the specified `VkImageFormatListCreateInfo` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkImageFormatListCreateInfoKHR value)`	Prepends the specified `VkImageFormatListCreateInfoKHR` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkSurfaceFullScreenExclusiveInfoEXT value)`	Prepends the specified `VkSurfaceFullScreenExclusiveInfoEXT` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkSurfaceFullScreenExclusiveWin32InfoEXT value)`	Prepends the specified `VkSurfaceFullScreenExclusiveWin32InfoEXT` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkSwapchainCounterCreateInfoEXT value)`	Prepends the specified `VkSwapchainCounterCreateInfoEXT` value to the `pNext` chain.
`VkSwapchainCreateInfoKHR`	`pNext(VkSwapchainDisplayNativeHdrCreateInfoAMD value)`	Prepends the specified `VkSwapchainDisplayNativeHdrCreateInfoAMD` value to the `pNext` chain.
`java.nio.IntBuffer`	`pQueueFamilyIndices()`	a pointer to an array of queue family indices having access to the images(s) of the swapchain when `imageSharingMode` is `SHARING_MODE_CONCURRENT`.
`VkSwapchainCreateInfoKHR`	`pQueueFamilyIndices(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pQueueFamilyIndices()` field.
`int`	`presentMode()`	the presentation mode the swapchain will use.
`VkSwapchainCreateInfoKHR`	`presentMode(int value)`	Sets the specified value to the `presentMode()` field.
`int`	`preTransform()`	a `VkSurfaceTransformFlagBitsKHR` value describing the transform, relative to the presentation engine’s natural orientation, applied to the image content prior to presentation.
`VkSwapchainCreateInfoKHR`	`preTransform(int value)`	Sets the specified value to the `preTransform()` field.
`int`	`queueFamilyIndexCount()`	the number of queue families having access to the image(s) of the swapchain when `imageSharingMode` is `SHARING_MODE_CONCURRENT`.
`VkSwapchainCreateInfoKHR`	`queueFamilyIndexCount(int value)`	Sets the specified value to the `queueFamilyIndexCount()` field.
`VkSwapchainCreateInfoKHR`	`set(int sType, long pNext, int flags, long surface, int minImageCount, int imageFormat, int imageColorSpace, VkExtent2D imageExtent, int imageArrayLayers, int imageUsage, int imageSharingMode, int queueFamilyIndexCount, java.nio.IntBuffer pQueueFamilyIndices, int preTransform, int compositeAlpha, int presentMode, boolean clipped, long oldSwapchain)`	Initializes this struct with the specified values.
`VkSwapchainCreateInfoKHR`	`set(VkSwapchainCreateInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkSwapchainCreateInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkSwapchainCreateInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR` value to the `sType()` field.
`long`	`surface()`	the surface onto which the swapchain will present images.
`VkSwapchainCreateInfoKHR`	`surface(long value)`	Sets the specified value to the `surface()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, SURFACE, MINIMAGECOUNT, IMAGEFORMAT, IMAGECOLORSPACE, IMAGEEXTENT, IMAGEARRAYLAYERS, IMAGEUSAGE, IMAGESHARINGMODE, QUEUEFAMILYINDEXCOUNT, PQUEUEFAMILYINDICES, PRETRANSFORM, COMPOSITEALPHA, PRESENTMODE, CLIPPED, OLDSWAPCHAIN
    
    The struct member offsets.
- Constructor Detail
  - VkSwapchainCreateInfoKHR
```
public VkSwapchainCreateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkSwapchainCreateInfoKHR 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()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - flags
```
public int flags()
```
    a bitmask of VkSwapchainCreateFlagBitsKHR indicating parameters of the swapchain creation.
  - surface
```
public long surface()
```
    the surface onto which the swapchain will present images. If the creation succeeds, the swapchain becomes associated with surface.
  - minImageCount
```
public int minImageCount()
```
    the minimum number of presentable images that the application needs. The implementation will either create the swapchain with at least that many images, or it will fail to create the swapchain.
  - imageFormat
```
public int imageFormat()
```
    a VkFormat value specifying the format the swapchain image(s) will be created with.
  - imageColorSpace
```
public int imageColorSpace()
```
    a VkColorSpaceKHR value specifying the way the swapchain interprets image data.
  - imageExtent
```
public VkExtent2D imageExtent()
```
    the size (in pixels) of the swapchain image(s). The behavior is platform-dependent if the image extent does not match the surface’s currentExtent as returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR.
    Note
    
    On some platforms, it is normal that maxImageExtent may become (0, 0), for example when the window is minimized. In such a case, it is not possible to create a swapchain due to the Valid Usage requirements.
  - imageArrayLayers
```
public int imageArrayLayers()
```
    the number of views in a multiview/stereo surface. For non-stereoscopic-3D applications, this value is 1.
  - imageUsage
```
public int imageUsage()
```
    a bitmask of VkImageUsageFlagBits describing the intended usage of the (acquired) swapchain images.
  - imageSharingMode
```
public int imageSharingMode()
```
    the sharing mode used for the image(s) of the swapchain.
  - queueFamilyIndexCount
```
public int queueFamilyIndexCount()
```
    the number of queue families having access to the image(s) of the swapchain when imageSharingMode is SHARING_MODE_CONCURRENT.
  - pQueueFamilyIndices
```
@Nullable
public java.nio.IntBuffer pQueueFamilyIndices()
```
    a pointer to an array of queue family indices having access to the images(s) of the swapchain when imageSharingMode is SHARING_MODE_CONCURRENT.
  - preTransform
```
public int preTransform()
```
    a VkSurfaceTransformFlagBitsKHR value describing the transform, relative to the presentation engine’s natural orientation, applied to the image content prior to presentation. If it does not match the currentTransform value returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR, the presentation engine will transform the image content as part of the presentation operation.
  - compositeAlpha
```
public int compositeAlpha()
```
    a VkCompositeAlphaFlagBitsKHR value indicating the alpha compositing mode to use when this surface is composited together with other surfaces on certain window systems.
  - presentMode
```
public int presentMode()
```
    the presentation mode the swapchain will use. A swapchain’s present mode determines how incoming present requests will be processed and queued internally.
  - clipped
```
public boolean clipped()
```
    specifies whether the Vulkan implementation is allowed to discard rendering operations that affect regions of the surface that are not visible.
    
    If set to TRUE, the presentable images associated with the swapchain may not own all of their pixels. Pixels in the presentable images that correspond to regions of the target surface obscured by another window on the desktop, or subject to some other clipping mechanism will have undefined content when read back. Fragment shaders may not execute for these pixels, and thus any side effects they would have had will not occur. Setting TRUE does not guarantee any clipping will occur, but allows more efficient presentation methods to be used on some platforms.
    
    If set to FALSE, presentable images associated with the swapchain will own all of the pixels they contain.
    Note
    
    Applications should set this value to TRUE if they do not expect to read back the content of presentable images before presenting them or after reacquiring them, and if their fragment shaders do not have any side effects that require them to run for all pixels in the presentable image.
  - oldSwapchain
```
public long oldSwapchain()
```
    NULL_HANDLE, or the existing non-retired swapchain currently associated with surface. Providing a valid oldSwapchain may aid in the resource reuse, and also allows the application to still present any images that are already acquired from it.
    Upon calling vkCreateSwapchainKHR with an oldSwapchain that is not NULL_HANDLE, oldSwapchain is retired — even if creation of the new swapchain fails. The new swapchain is created in the non-retired state whether or not oldSwapchain is NULL_HANDLE.
    
    Upon calling vkCreateSwapchainKHR with an oldSwapchain that is not NULL_HANDLE, any images from oldSwapchain that are not acquired by the application may be freed by the implementation, which may occur even if creation of the new swapchain fails. The application can destroy oldSwapchain to free all memory associated with oldSwapchain.
    
    Note
    
    Multiple retired swapchains can be associated with the same VkSurfaceKHR through multiple uses of oldSwapchain that outnumber calls to DestroySwapchainKHR.
    
    After oldSwapchain is retired, the application can pass to QueuePresentKHR any images it had already acquired from oldSwapchain. E.g., an application may present an image from the old swapchain before an image from the new swapchain is ready to be presented. As usual, QueuePresentKHR may fail if oldSwapchain has entered a state that causes ERROR_OUT_OF_DATE_KHR to be returned.
    
    The application can continue to use a shared presentable image obtained from oldSwapchain until a presentable image is acquired from the new swapchain, as long as it has not entered a state that causes it to return ERROR_OUT_OF_DATE_KHR.
  - sType
```
public VkSwapchainCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkSwapchainCreateInfoKHR sType$Default()
```
    Sets the STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR value to the sType() field.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkDeviceGroupSwapchainCreateInfoKHR value)
```
    Prepends the specified VkDeviceGroupSwapchainCreateInfoKHR value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkImageFormatListCreateInfo value)
```
    Prepends the specified VkImageFormatListCreateInfo value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkImageFormatListCreateInfoKHR value)
```
    Prepends the specified VkImageFormatListCreateInfoKHR value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkSurfaceFullScreenExclusiveInfoEXT value)
```
    Prepends the specified VkSurfaceFullScreenExclusiveInfoEXT value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkSurfaceFullScreenExclusiveWin32InfoEXT value)
```
    Prepends the specified VkSurfaceFullScreenExclusiveWin32InfoEXT value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkSwapchainCounterCreateInfoEXT value)
```
    Prepends the specified VkSwapchainCounterCreateInfoEXT value to the pNext chain.
  - pNext
```
public VkSwapchainCreateInfoKHR pNext(VkSwapchainDisplayNativeHdrCreateInfoAMD value)
```
    Prepends the specified VkSwapchainDisplayNativeHdrCreateInfoAMD value to the pNext chain.
  - flags
```
public VkSwapchainCreateInfoKHR flags(int value)
```
    Sets the specified value to the flags() field.
  - surface
```
public VkSwapchainCreateInfoKHR surface(long value)
```
    Sets the specified value to the surface() field.
  - minImageCount
```
public VkSwapchainCreateInfoKHR minImageCount(int value)
```
    Sets the specified value to the minImageCount() field.
  - imageFormat
```
public VkSwapchainCreateInfoKHR imageFormat(int value)
```
    Sets the specified value to the imageFormat() field.
  - imageColorSpace
```
public VkSwapchainCreateInfoKHR imageColorSpace(int value)
```
    Sets the specified value to the imageColorSpace() field.
  - imageExtent
```
public VkSwapchainCreateInfoKHR imageExtent(VkExtent2D value)
```
    Copies the specified VkExtent2D to the imageExtent() field.
  - imageExtent
```
public VkSwapchainCreateInfoKHR imageExtent(java.util.function.Consumer<VkExtent2D> consumer)
```
    Passes the imageExtent() field to the specified Consumer.
  - imageArrayLayers
```
public VkSwapchainCreateInfoKHR imageArrayLayers(int value)
```
    Sets the specified value to the imageArrayLayers() field.
  - imageUsage
```
public VkSwapchainCreateInfoKHR imageUsage(int value)
```
    Sets the specified value to the imageUsage() field.
  - imageSharingMode
```
public VkSwapchainCreateInfoKHR imageSharingMode(int value)
```
    Sets the specified value to the imageSharingMode() field.
  - queueFamilyIndexCount
```
public VkSwapchainCreateInfoKHR queueFamilyIndexCount(int value)
```
    Sets the specified value to the queueFamilyIndexCount() field.
  - pQueueFamilyIndices
```
public VkSwapchainCreateInfoKHR pQueueFamilyIndices(@Nullable
                                                    java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pQueueFamilyIndices() field.
  - preTransform
```
public VkSwapchainCreateInfoKHR preTransform(int value)
```
    Sets the specified value to the preTransform() field.
  - compositeAlpha
```
public VkSwapchainCreateInfoKHR compositeAlpha(int value)
```
    Sets the specified value to the compositeAlpha() field.
  - presentMode
```
public VkSwapchainCreateInfoKHR presentMode(int value)
```
    Sets the specified value to the presentMode() field.
  - clipped
```
public VkSwapchainCreateInfoKHR clipped(boolean value)
```
    Sets the specified value to the clipped() field.
  - oldSwapchain
```
public VkSwapchainCreateInfoKHR oldSwapchain(long value)
```
    Sets the specified value to the oldSwapchain() field.
  - set
```
public VkSwapchainCreateInfoKHR set(int sType,
                                    long pNext,
                                    int flags,
                                    long surface,
                                    int minImageCount,
                                    int imageFormat,
                                    int imageColorSpace,
                                    VkExtent2D imageExtent,
                                    int imageArrayLayers,
                                    int imageUsage,
                                    int imageSharingMode,
                                    int queueFamilyIndexCount,
                                    @Nullable
                                    java.nio.IntBuffer pQueueFamilyIndices,
                                    int preTransform,
                                    int compositeAlpha,
                                    int presentMode,
                                    boolean clipped,
                                    long oldSwapchain)
```
    Initializes this struct with the specified values.
  - set
```
public VkSwapchainCreateInfoKHR set(VkSwapchainCreateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSwapchainCreateInfoKHR malloc()
```
    Returns a new VkSwapchainCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSwapchainCreateInfoKHR calloc()
```
    Returns a new VkSwapchainCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSwapchainCreateInfoKHR create()
```
    Returns a new VkSwapchainCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkSwapchainCreateInfoKHR create(long address)
```
    Returns a new VkSwapchainCreateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSwapchainCreateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSwapchainCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkSwapchainCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSwapchainCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkSwapchainCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSwapchainCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSwapchainCreateInfoKHR.Buffer create(long address,
                                                     int capacity)
```
    Create a VkSwapchainCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSwapchainCreateInfoKHR.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR mallocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR callocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR.Buffer mallocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR.Buffer callocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static VkSwapchainCreateInfoKHR.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - malloc
```
public static VkSwapchainCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkSwapchainCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSwapchainCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkSwapchainCreateInfoKHR.Buffer malloc(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSwapchainCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkSwapchainCreateInfoKHR.Buffer calloc(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSwapchainCreateInfoKHR.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().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nsurface
```
public static long nsurface(long struct)
```
    Unsafe version of surface().
  - nminImageCount
```
public static int nminImageCount(long struct)
```
    Unsafe version of minImageCount().
  - nimageFormat
```
public static int nimageFormat(long struct)
```
    Unsafe version of imageFormat().
  - nimageColorSpace
```
public static int nimageColorSpace(long struct)
```
    Unsafe version of imageColorSpace().
  - nimageExtent
```
public static VkExtent2D nimageExtent(long struct)
```
    Unsafe version of imageExtent().
  - nimageArrayLayers
```
public static int nimageArrayLayers(long struct)
```
    Unsafe version of imageArrayLayers().
  - nimageUsage
```
public static int nimageUsage(long struct)
```
    Unsafe version of imageUsage().
  - nimageSharingMode
```
public static int nimageSharingMode(long struct)
```
    Unsafe version of imageSharingMode().
  - nqueueFamilyIndexCount
```
public static int nqueueFamilyIndexCount(long struct)
```
    Unsafe version of queueFamilyIndexCount().
  - npQueueFamilyIndices
```
@Nullable
public static java.nio.IntBuffer npQueueFamilyIndices(long struct)
```
    Unsafe version of pQueueFamilyIndices.
  - npreTransform
```
public static int npreTransform(long struct)
```
    Unsafe version of preTransform().
  - ncompositeAlpha
```
public static int ncompositeAlpha(long struct)
```
    Unsafe version of compositeAlpha().
  - npresentMode
```
public static int npresentMode(long struct)
```
    Unsafe version of presentMode().
  - nclipped
```
public static int nclipped(long struct)
```
    Unsafe version of clipped().
  - noldSwapchain
```
public static long noldSwapchain(long struct)
```
    Unsafe version of oldSwapchain().
  - 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.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nsurface
```
public static void nsurface(long struct,
                            long value)
```
    Unsafe version of surface.
  - nminImageCount
```
public static void nminImageCount(long struct,
                                  int value)
```
    Unsafe version of minImageCount.
  - nimageFormat
```
public static void nimageFormat(long struct,
                                int value)
```
    Unsafe version of imageFormat.
  - nimageColorSpace
```
public static void nimageColorSpace(long struct,
                                    int value)
```
    Unsafe version of imageColorSpace.
  - nimageExtent
```
public static void nimageExtent(long struct,
                                VkExtent2D value)
```
    Unsafe version of imageExtent.
  - nimageArrayLayers
```
public static void nimageArrayLayers(long struct,
                                     int value)
```
    Unsafe version of imageArrayLayers.
  - nimageUsage
```
public static void nimageUsage(long struct,
                               int value)
```
    Unsafe version of imageUsage.
  - nimageSharingMode
```
public static void nimageSharingMode(long struct,
                                     int value)
```
    Unsafe version of imageSharingMode.
  - nqueueFamilyIndexCount
```
public static void nqueueFamilyIndexCount(long struct,
                                          int value)
```
    Sets the specified value to the queueFamilyIndexCount field of the specified struct.
  - npQueueFamilyIndices
```
public static void npQueueFamilyIndices(long struct,
                                        @Nullable
                                        java.nio.IntBuffer value)
```
    Unsafe version of pQueueFamilyIndices.
  - npreTransform
```
public static void npreTransform(long struct,
                                 int value)
```
    Unsafe version of preTransform.
  - ncompositeAlpha
```
public static void ncompositeAlpha(long struct,
                                   int value)
```
    Unsafe version of compositeAlpha.
  - npresentMode
```
public static void npresentMode(long struct,
                                int value)
```
    Unsafe version of presentMode.
  - nclipped
```
public static void nclipped(long struct,
                            int value)
```
    Unsafe version of clipped.
  - noldSwapchain
```
public static void noldSwapchain(long struct,
                                 long value)
```
    Unsafe version of oldSwapchain.

Class VkSwapchainCreateInfoKHR

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, SURFACE, MINIMAGECOUNT, IMAGEFORMAT, IMAGECOLORSPACE, IMAGEEXTENT, IMAGEARRAYLAYERS, IMAGEUSAGE, IMAGESHARINGMODE, QUEUEFAMILYINDEXCOUNT, PQUEUEFAMILYINDICES, PRETRANSFORM, COMPOSITEALPHA, PRESENTMODE, CLIPPED, OLDSWAPCHAIN

Constructor Detail

VkSwapchainCreateInfoKHR

Method Detail

sizeof

sType

pNext

flags

surface

minImageCount

imageFormat

imageColorSpace

imageExtent

Note

imageArrayLayers

imageUsage

imageSharingMode

queueFamilyIndexCount

pQueueFamilyIndices

preTransform

compositeAlpha

presentMode

clipped

Note

oldSwapchain

Note

sType

sType$Default

pNext

pNext

pNext

pNext

pNext

pNext

pNext

pNext

flags

surface

minImageCount

imageFormat

imageColorSpace

imageExtent

imageExtent

imageArrayLayers

imageUsage

imageSharingMode

queueFamilyIndexCount

pQueueFamilyIndices

preTransform

compositeAlpha

presentMode

clipped

oldSwapchain

set

set

malloc

calloc

create

create

createSafe

malloc